Click or drag to resize
OSIsoft, LLC

PIPointQueryParseQuery Method

Namespace:  OSIsoft.AF.PI
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version:
public static IList<IEnumerable<PIPointQuery>> ParseQuery(
	PIServer piServer,
	string query,
	bool searchNameAndDescriptor = false,
	AFSearchTextOption searchOption = AFSearchTextOption.ExactMatch


Type: OSIsoft.AF.PIPIServer
The PIServer to search for the desired PIPoint objects.
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: IListIEnumerablePIPointQuery
Returns lists of PIPointQuery query conditions to be passed to the FindPIPoints(PIServer, IListIEnumerablePIPointQuery, IEnumerableString) method.
Version Information


Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8
See Also
Enabling Operational Intelligence