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

AF SDK Reference

AFSearch.ParseQuery Method

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFSearch.ParseQuery Method

Note: This API is now obsolete.

Parses the specified search query into search tokens which can be used to search for objects.

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

Syntax

[ObsoleteAttribute("Use ParseQueryString instead. This method cannot support Or tokens.")]
public static IList<AFSearchToken> ParseQuery(
	string query
)
<ObsoleteAttribute("Use ParseQueryString instead. This method cannot support Or tokens.")>
Public Shared Function ParseQuery ( 
	query As String
) As IList(Of AFSearchToken)

Dim query As String
Dim returnValue As IList(Of AFSearchToken)

returnValue = AFSearch.ParseQuery(query)
public:
[ObsoleteAttribute(L"Use ParseQueryString instead. This method cannot support Or tokens.")]
static IList<AFSearchToken>^ ParseQuery(
	String^ query
)
[<ObsoleteAttribute("Use ParseQueryString instead. This method cannot support Or tokens.")>]
static member ParseQuery : 
        query : string -> IList<AFSearchToken> 

Parameters

query
Type: SystemString
The search query to be parsed. Strings will be interpreted with the Parse(String, AFTime, IFormatProvider) method so that relative formats with intervals ("*", "T+3h", etc.) are also supported. Relative time intervals are based on the database's QueryDate.

Return Value

Type: IListAFSearchToken
Returns a list of search tokens representing the parts of the parsed query.

Remarks

The specified query is parsed into tokens. These tokens can be used to perform a search for objects from the server. See Search Overview for more information.

Version Information

AFSDK

Obsolete (compiler warning) in 3.1.1
Obsolete (compiler warning) in 3.1.0
Obsolete (compiler warning) in 3.0.2
Obsolete (compiler warning) in 3.0.1
Obsolete (compiler warning) in 3.0.0
Obsolete (compiler warning) in 2.10.11
Obsolete (compiler warning) in 2.10.5

See Also

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