AF SDK Reference

AFObject.GetPath Method

Save PDF

TABLE OF CONTENTS

AFObject.GetPath Method

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Returns the full path to the object, using just the names.

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

Syntax

public string GetPath()

Public Function GetPath As String

Dim instance As AFObject
Dim returnValue As String

returnValue = instance.GetPath()

public:
String^ GetPath()

member GetPath : unit -> string

Return Value

Type: String
Returns the full path to the object, using just the names.

Remarks

A path to an object is created by this method and can be restored from a string using one of the AFObjectFindObject or AFObjectFindObjects methods. A path, such as "\\MySystem\MyDatabase\MyElement|Attribute1", can be used to reference any object derived from AFObject. See Path Syntax for a complete description of the path syntax.

AF SDK Reference