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

AF SDK Reference

AFEventFrame.GetPaths Method

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFEventFrame.GetPaths Method
Get all the relative paths to this AFEventFrame.

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

Syntax

public string[] GetPaths(
	string relativePath = null
)
Public Function GetPaths ( 
	Optional relativePath As String = Nothing
) As String()

Dim instance As AFEventFrame
Dim relativePath As String
Dim returnValue As String()

returnValue = instance.GetPaths(relativePath)
public:
array<String^>^ GetPaths(
	String^ relativePath = nullptr
)
member GetPaths : 
        ?relativePath : string 
(* Defaults:
        let _relativePath = defaultArg relativePath null
*)
-> string[] 

Parameters

relativePath (Optional)
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 eventframe relative to the database. A path of "\\Server1\Database2\RootEF" would return paths to the eventframe relative to "RootEF". If , then all the full paths to the eventframe will be returned.

Return Value

Type: String
Returns all the relative paths to this AFEventFrame.

Remarks

This method will return all the paths to the AFEventFrame where the GetPath Overload method will return the single primary path.

This method could be an expensive operation because the paths had 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.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5

See Also

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