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

AF SDK Reference

AFPathToken Constructor (AFIdentity, String, Nullable(Guid), Boolean, Boolean)

AFPathToken Constructor (AFIdentity, String, Nullable(Guid), Boolean, Boolean)

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFPathToken Constructor (AFIdentity, String, Nullable(Guid), Boolean, Boolean)
Creates an AFPathToken instance representing an AFObject.

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

Syntax

public AFPathToken(
	AFIdentity identity,
	string name = null,
	Guid? id = null,
	bool nameIsPreferred = false,
	bool attributeIsPreferred = false
)
Public Sub New ( 
	identity As AFIdentity,
	Optional name As String = Nothing,
	Optional id As Guid? = Nothing,
	Optional nameIsPreferred As Boolean = false,
	Optional attributeIsPreferred As Boolean = false
)

Dim identity As AFIdentity
Dim name As String
Dim id As Guid?
Dim nameIsPreferred As Boolean
Dim attributeIsPreferred As Boolean

Dim instance As New AFPathToken(identity, 
	name, id, nameIsPreferred, attributeIsPreferred)
public:
AFPathToken(
	AFIdentity identity, 
	String^ name = nullptr, 
	Nullable<Guid> id = nullptr, 
	bool nameIsPreferred = false, 
	bool attributeIsPreferred = false
)
new : 
        identity : AFIdentity * 
        ?name : string * 
        ?id : Nullable<Guid> * 
        ?nameIsPreferred : bool * 
        ?attributeIsPreferred : bool 
(* Defaults:
        let _name = defaultArg name null
        let _id = defaultArg id null
        let _nameIsPreferred = defaultArg nameIsPreferred false
        let _attributeIsPreferred = defaultArg attributeIsPreferred false
*)
-> AFPathToken

Parameters

identity
Type: OSIsoft.AFAFIdentity
The AFIdentity of the desired object.
name (Optional)
Type: SystemString
The name that identifies the desired object.
id (Optional)
Type: SystemNullableGuid
The unique identifier for the desired object.
nameIsPreferred (Optional)
Type: SystemBoolean
Indicates whether the Name or ID is preferred when searching for the object.
attributeIsPreferred (Optional)
Type: SystemBoolean
Indicates if an AFAttribute is the preferred returned object.

Remarks

This constructor will initialize all the fields with the values specified as parameters to represent an AFObject.

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, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6

See Also

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