AFPathToken Constructor (AFIdentity, String, Nullable(Guid), Boolean, Boolean)
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
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.