 | PIPointFindPIPoints Method (PIServer, String, String, IEnumerableString) |
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
Syntaxpublic static IEnumerable<PIPoint> FindPIPoints(
PIServer piServer,
string nameFilter,
string sourceFilter = null,
IEnumerable<string> attributeNames = null
)
Public Shared Function FindPIPoints (
piServer As PIServer,
nameFilter As String,
Optional sourceFilter As String = Nothing,
Optional attributeNames As IEnumerable(Of String) = Nothing
) As IEnumerable(Of PIPoint)
Dim piServer As PIServer
Dim nameFilter As String
Dim sourceFilter As String
Dim attributeNames As IEnumerable(Of String)
Dim returnValue As IEnumerable(Of PIPoint)
returnValue = PIPoint.FindPIPoints(piServer,
nameFilter, sourceFilter, attributeNames)
public:
static IEnumerable<PIPoint^>^ FindPIPoints(
PIServer^ piServer,
String^ nameFilter,
String^ sourceFilter = nullptr,
IEnumerable<String^>^ attributeNames = nullptr
)
static member FindPIPoints :
piServer : PIServer *
nameFilter : string *
?sourceFilter : string *
?attributeNames : IEnumerable<string>
(* Defaults:
let _sourceFilter = defaultArg sourceFilter null
let _attributeNames = defaultArg attributeNames null
*)
-> IEnumerable<PIPoint>
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.
Return Value
Type:
IEnumerablePIPoint
Returns the enumerable list of
PIPoint objects matching the specified
nameFilter
and
sourceFilter.
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.
Version InformationAFSDK
Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5
See Also