PIPoint.FindPIPointsAsync Method (PIServer, IEnumerable(String), IEnumerable(String), CancellationToken)
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
Find a list of PIPoint objects from a specified list of point names.
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public static Task<IList<PIPoint>> FindPIPointsAsync( PIServer piServer, IEnumerable<string> names, IEnumerable<string> attributeNames = null, CancellationToken cancellationToken = default )
Public Shared Function FindPIPointsAsync ( piServer As PIServer, names As IEnumerable(Of String), Optional attributeNames As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing ) As Task(Of IList(Of PIPoint)) Dim piServer As PIServer Dim names As IEnumerable(Of String) Dim attributeNames As IEnumerable(Of String) Dim cancellationToken As CancellationToken Dim returnValue As Task(Of IList(Of PIPoint)) returnValue = PIPoint.FindPIPointsAsync(piServer, names, attributeNames, cancellationToken)
public: static Task<IList<PIPoint^>^>^ FindPIPointsAsync( PIServer^ piServer, IEnumerable<String^>^ names, IEnumerable<String^>^ attributeNames = nullptr, CancellationToken cancellationToken = CancellationToken() )
static member FindPIPointsAsync : piServer : PIServer * names : IEnumerable<string> * ?attributeNames : IEnumerable<string> * ?cancellationToken : CancellationToken (* Defaults: let _attributeNames = defaultArg attributeNames null let _cancellationToken = defaultArg cancellationToken new CancellationToken() *) -> Task<IList<PIPoint>>
Parameters
- piServer
- Type: OSIsoft.AF.PIPIServer
The PIServer to search for the desired PIPoint objects. - names
- Type: System.Collections.GenericIEnumerableString
The list of point names of the desired PIPoint objects to be found. Note that exact point names are expected. If there are entries containing wildcard, they will be ignored. Hence, only points matching exact name entries will be returned. Use FindPIPointsAsync(PIServer, IEnumerablePIPointQuery, IEnumerableString, CancellationToken) or FindPIPointsAsync(PIServer, IListIEnumerablePIPointQuery, IEnumerableString, CancellationToken) to search for points with wildcard name or names, respectively. - 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 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: TaskIListPIPointReturns a task whose result is the list of PIPoint objects matching the specified names.
Exceptions
| Exception | Condition |
|---|---|
| AggregateException | Asynchronous methods throw AggregateException on failure which will contain one or more exceptions containing the failure. |
Remarks
This method finds a list of PIPoint objects from the specified list of point names.
| 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. |