PIPoint.FindPIPoints Method (PIServer, IList(IEnumerable(PIPointQuery)), IEnumerable(String))

public static IEnumerable<PIPoint> FindPIPoints(
	PIServer piServer,
	IList<IEnumerable<PIPointQuery>> queries,
	IEnumerable<string> attributeNames = null
)

Public Shared Function FindPIPoints ( 
	piServer As PIServer,
	queries As IList(Of IEnumerable(Of PIPointQuery)),
	Optional attributeNames As IEnumerable(Of String) = Nothing
) As IEnumerable(Of PIPoint)

Dim piServer As PIServer
Dim queries As IList(Of IEnumerable(Of PIPointQuery))
Dim attributeNames As IEnumerable(Of String)
Dim returnValue As IEnumerable(Of PIPoint)

returnValue = PIPoint.FindPIPoints(piServer, 
	queries, attributeNames)

public:
static IEnumerable<PIPoint^>^ FindPIPoints(
	PIServer^ piServer, 
	IList<IEnumerable<PIPointQuery>^>^ queries, 
	IEnumerable<String^>^ attributeNames = nullptr
)

static member FindPIPoints : 
        piServer : PIServer * 
        queries : IList<IEnumerable<PIPointQuery>> * 
        ?attributeNames : IEnumerable<string> 
(* Defaults:
        let _attributeNames = defaultArg attributeNames null
*)
-> IEnumerable<PIPoint> 

Parameters

piServer

Type: OSIsoft.AF.PIPIServer
The PIServer to search for the desired PIPoint objects.

queries

Type: System.Collections.GenericIListIEnumerablePIPointQuery
Each inner lists of PIPoint attribute query filters are ANDed together to find the desired PIPoint objects. The results of each of the inner lists are ORed together to return the complete list. 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.

Return Value

This method finds an enumerable list of PIPoint objects from the specified list of query filter conditions ORed together. The conditions within each inner 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
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.

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.

AFSDK

Reference

Other Resources