AF SDK Reference

PIPoint.FindPIPointsByPath Method

Save PDF

PIPoint.FindPIPointsByPath Method

Save PDF

Last UpdatedNov 18, 2025
3 minute read

Find a collection of PIPoint objects from a specified list of path names as keyed results. The path name is the key to lookup the PIPoint object in the result.

Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public static AFKeyedResults<string, PIPoint> FindPIPointsByPath(
	IEnumerable<string> paths
)

Public Shared Function FindPIPointsByPath ( 
	paths As IEnumerable(Of String)
) As AFKeyedResults(Of String, PIPoint)

Dim paths As IEnumerable(Of String)
Dim returnValue As AFKeyedResults(Of String, PIPoint)

returnValue = PIPoint.FindPIPointsByPath(paths)

public:
static AFKeyedResults<String^, PIPoint^>^ FindPIPointsByPath(
	IEnumerable<String^>^ paths
)

static member FindPIPointsByPath : 
        paths : IEnumerable<string> -> AFKeyedResults<string, PIPoint>

Parameters

paths: Type: System.Collections.GenericIEnumerableString
The collection of strings containing fully qualified pathnames to locate each PIPoint.

Return Value

Type: AFKeyedResultsString, PIPoint
Returns a dictionary of results where the key is the specified path and its value is the PIPoint resolved from the path.

Remarks

This method is used to resolve a list of tag path names to a collection of PIPoint objects. In addition to handling more than one server, this method will also handle duplicate pathnames within the requested list. Any unresolved tag path names can be found in the errors collection in the result. Server level error can be found in the PIServer errors collection of the result.

The fully qualified pathname should be in the form \\server\point. The server portion of the path should be in one of the following forms. The order of the serverName and serverID determines the preference (the first one has higher preference) when resolving the server by Name or ID.

serverName
{serverID}
serverName;{serverID}
{serverID};serverName
PIServers[serverName]
PIServers[{serverID}]
PIServers[{serverID};serverName]
PIServers[serverName;{serverID}]

The PI Point (tag) portion of the path should be in one of the following forms. The order of the pointName and pointID determines the preference (the first one has higher preference) when resolving the PI Point by Name or ID.

pointName
?pointID
pointName?pointID
pointName;?pointID
?pointID;pointName
PIPoints[pointName]
PIPoints[?pointID]
PIPoints[?pointID;pointName]
PIPoints[pointName?pointID]
PIPoints[pointName;?pointID]

AF SDK Reference