Click or drag to resize
OSIsoft, LLC

PIPointFindPIPointsAsync Method (PIServer, String, String, IEnumerableString, CancellationToken)

Find an enumerable list of PIPoint objects from a point name and point source filter.

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

Parameters

piServer
Type: OSIsoft.AF.PIPIServer
The PIServer to search for the desired PIPoint objects.
nameFilter
Type: SystemString
The PIPoint name filter used to search for the desired PIPoint objects.
sourceFilter (Optional)
Type: SystemString
The PIPoint source filter used to search for the desired PIPoint objects. If , then only the nameFilter is used for the search.
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 nameFilter and sourceFilter.
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 point name and point source filter. Wildcards * and ? can be used in the filter expressions. 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.

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