Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

PIPoint.GetPath Method (AFEncodeType)

  • Last UpdatedNov 18, 2025
  • 2 minute read
PIPoint.GetPath Method (AFEncodeType)
Returns the path to the PIPoint using the name and/or id as specified by the encodeType.

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

Syntax

public string GetPath(
	AFEncodeType encodeType
)
Public Function GetPath ( 
	encodeType As AFEncodeType
) As String

Dim instance As PIPoint
Dim encodeType As AFEncodeType
Dim returnValue As String

returnValue = instance.GetPath(encodeType)
public:
String^ GetPath(
	AFEncodeType encodeType
)
member GetPath : 
        encodeType : AFEncodeType -> string 

Parameters

encodeType
Type: OSIsoft.AFAFEncodeType
Specifies how the path to the PIPoint is encoded. See AFEncodeType for details.

Return Value

Type: String
Returns the path to the PIPoint.

Remarks

A path to a PIPoint is created by one of the GetPath Overload methods is restored from a string by the FindPIPoint(String) method.

The GetPath method is similar to using the IPIPersist.Persist method to save an object, but has options that can produce a more human readable format. If the string is encoded with either the ShortName or FriendlyName option, it cannot be restored using FindPIPoint.

Version Information

AFSDK


See Also

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in