Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

IAFSearch(T).FindObjects Method

  • Last UpdatedNov 18, 2025
  • 3 minute read
IAFSearch(T).FindObjects Method
This method will return the objects that match the search tokens.

Namespace:  OSIsoft.AF.Search
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

IEnumerable<T> FindObjects(
	int startIndex = 0,
	bool fullLoad = false,
	int pageSize = 0
)
Function FindObjects ( 
	Optional startIndex As Integer = 0,
	Optional fullLoad As Boolean = false,
	Optional pageSize As Integer = 0
) As IEnumerable(Of T)

Dim instance As IAFSearch
Dim startIndex As Integer
Dim fullLoad As Boolean
Dim pageSize As Integer
Dim returnValue As IEnumerable(Of T)

returnValue = instance.FindObjects(startIndex, 
	fullLoad, pageSize)
IEnumerable<T>^ FindObjects(
	int startIndex = 0, 
	bool fullLoad = false, 
	int pageSize = 0
)
abstract FindObjects : 
        ?startIndex : int * 
        ?fullLoad : bool * 
        ?pageSize : int 
(* Defaults:
        let _startIndex = defaultArg startIndex 0
        let _fullLoad = defaultArg fullLoad false
        let _pageSize = defaultArg pageSize 0
*)
-> IEnumerable<'T> 

Parameters

startIndex (Optional)
Type: SystemInt32
The starting index (zero based) of the items to be returned.
fullLoad (Optional)
Type: SystemBoolean
If , then the returned objects will be full loaded. If , then the returned objects may not be fully loaded and will require another call to the server if additional information about the object is requested that is not already loaded.
pageSize (Optional)
Type: SystemInt32
The page size used for retrieving objects from the server. If this parameter is less than or equal to zero, then the page size will be set to the current value of the CollectionPageSize setting.

Return Value

Type: IEnumerableT
Returns an enumerable list of the objects found using the search tokens for this search object.

Exceptions

ExceptionCondition
FormatException This exception is thrown if the ThrowOnError property is and there is a format error in the search query.
NotSupportedException This exception is thrown if the ThrowOnError property is and one of the filters is not supported or the query is too complex to be evaluated by the server.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in