PIPointQuery.ParseQuery Method
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Parses the query string into PIPointQuery lists to be used by the
FindPIPoints(PIServer, IListIEnumerablePIPointQuery, IEnumerableString)
method.
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public static IList<IEnumerable<PIPointQuery>> ParseQuery( PIServer piServer, string query, bool searchNameAndDescriptor = false, AFSearchTextOption searchOption = AFSearchTextOption.ExactMatch )
Public Shared Function ParseQuery ( piServer As PIServer, query As String, Optional searchNameAndDescriptor As Boolean = false, Optional searchOption As AFSearchTextOption = AFSearchTextOption.ExactMatch ) As IList(Of IEnumerable(Of PIPointQuery)) Dim piServer As PIServer Dim query As String Dim searchNameAndDescriptor As Boolean Dim searchOption As AFSearchTextOption Dim returnValue As IList(Of IEnumerable(Of PIPointQuery)) returnValue = PIPointQuery.ParseQuery(piServer, query, searchNameAndDescriptor, searchOption)
public: static IList<IEnumerable<PIPointQuery>^>^ ParseQuery( PIServer^ piServer, String^ query, bool searchNameAndDescriptor = false, AFSearchTextOption searchOption = AFSearchTextOption::ExactMatch )
static member ParseQuery : piServer : PIServer * query : string * ?searchNameAndDescriptor : bool * ?searchOption : AFSearchTextOption (* Defaults: let _searchNameAndDescriptor = defaultArg searchNameAndDescriptor false let _searchOption = defaultArg searchOption AFSearchTextOption.ExactMatch *) -> IList<IEnumerable<PIPointQuery>>
Parameters
- piServer
- Type: OSIsoft.AF.PIPIServer
The PIServer to search for the desired PIPoint objects. - query
- Type: SystemString
A query string specifying the conditions to be used to find the desired PIPoint objects. See PIPoint Query Syntax for more information. - searchNameAndDescriptor (Optional)
- Type: SystemBoolean
If and the Tag attribute name is specified and the Descriptor attribute name is not specified in the query, then both of these attributes will be searched using the Tag query value. Otherwise, this parameter will be ignored. - searchOption (Optional)
- Type: OSIsoft.AF.SearchAFSearchTextOption
The search option to be applied to the Tag query filter. If the Tag attribute name is not in the query, then this parameter will be ignored.
Return Value
Type: IListIEnumerablePIPointQueryReturns lists of PIPointQuery query conditions to be passed to the FindPIPoints(PIServer, IListIEnumerablePIPointQuery, IEnumerableString) method.
Remarks
The query string is parsed to generate query conditions to be passed to the
FindPIPoints(PIServer, IListIEnumerablePIPointQuery, IEnumerableString) method.