AFElement.GetPaths Method (String)
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Get all the relative paths to this AFElement.
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public string[] GetPaths( string relativePath )
Public Function GetPaths ( relativePath As String ) As String() Dim instance As AFElement Dim relativePath As String Dim returnValue As String() returnValue = instance.GetPaths(relativePath)
public: array<String^>^ GetPaths( String^ relativePath )
member GetPaths : relativePath : string -> string[]
Parameters
- relativePath
- Type: SystemString
The full path in ShortName format to the parent object that the returned paths should be relative. For example, "\\Server1\Database2" would return all the paths to the element relative to the database. A path of "\\Server1\Database2\RootElement" would return paths to the element relative to "RootElement". If , then all the full paths to the element will be returned.
Return Value
Type: StringReturns all the relative paths to this AFElement.
Remarks
This method will return all the paths to the AFElement where the GetPath Overload method will return the single primary path.
When connected to a 2015 (2.7) or later server, all the paths are returned in one bulk call from the server. In older servers, this method could be an expensive operation because the paths have to be computed in the client and could require at least one call to the server for each parent if they were not previously loaded.