AF SDK Reference

AFSearch.ParseQueryString Method

Save PDF

TABLE OF CONTENTS

AFSearch.ParseQueryString Method

Save PDF

Last UpdatedNov 18, 2025
2 minute read

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

public static IList<AFSearchTokenBase> ParseQueryString(
	string query
)

Public Shared Function ParseQueryString ( 
	query As String
) As IList(Of AFSearchTokenBase)

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

returnValue = AFSearch.ParseQueryString(query)

public:
static IList<AFSearchTokenBase^>^ ParseQueryString(
	String^ query
)

static member ParseQueryString : 
        query : string -> IList<AFSearchTokenBase>

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: IListAFSearchTokenBase
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

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5

AF SDK Reference