Click or drag to resize
OSIsoft, LLC

PIPointFindPIPointsAsync Method (PIServer, IEnumerablePIPointQuery, IEnumerableString, CancellationToken)

Find an enumerable list of PIPoint objects that match the specified query filter conditions.

Namespace:  OSIsoft.AF.PI
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.6.195
Syntax
public static Task<IEnumerable<PIPoint>> FindPIPointsAsync(
	PIServer piServer,
	IEnumerable<PIPointQuery> query,
	IEnumerable<string> attributeNames = null,
	CancellationToken cancellationToken = null
)

Parameters

piServer
Type: OSIsoft.AF.PIPIServer
The PIServer to search for the desired PIPoint objects.
query
Type: System.Collections.GenericIEnumerablePIPointQuery
A list of PIPoint attribute query filters that are ANDed together to find the desired PIPoint objects. The FindPIPoints(PIServer, String, Boolean, IEnumerableString, AFSearchTextOption) method can be used to parse a string query and generate this list of queries.
attributeNames (Optional)
Type: System.Collections.GenericIEnumerableString
The list of PIPoint attribute names to be loaded from the server as the PIPoint objects are found. The list of PIPoint attribute names can be obtained from the PIPointClass.GetAttributes method or the PICommonPointAttributes class. The GetAttribute(String) method can be used to access the loaded attribute values. If , then no attribute values are loaded for the returned PIPoints.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
A cancellation token used to abort processing before completion. Passing the default CancellationToken.None will run to completion or until the PIConnectionInfo.OperationTimeOut period elapses.

Return Value

Type: TaskIEnumerablePIPoint
Returns a task whose result is the enumerable list of PIPoint objects matching the specified query.
Exceptions
ExceptionCondition
AggregateException Asynchronous methods throw AggregateException on failure which will contain one or more exceptions containing the failure.
Remarks

This method finds an enumerable list of PIPoint objects from the specified query filter conditions. The conditions within the query list are ANDed together. If the conditions are mutually exclusive, then nothing will be returned. See PIPoint Query Syntax for a more information on the query syntax.

The points are returned from the server in blocks as the client is iterating through the list. When you stop iterating the returned list, the remaining points are not retrieved from the server.

Caution note Caution
A PI Point attribute may only be referenced one time per FindPIPoints call. Referencing a PI Point attribute multiple times will result in an error.

Note Notes to Callers
This call might use a background task to complete some of its work. See the Threading Overview for some matters to consider when execution transitions to another thread.

Version Information

AFSDK

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