AFEncodeType Enumeration
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Defines the different ways a reference to an object can be encoded using one of the
AFObjectGetPath methods.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public enum AFEncodeType
Public Enumeration AFEncodeType Dim instance As AFEncodeType
public enum class AFEncodeType
type AFEncodeType
Members
| Member name | Value | Description | |
|---|---|---|---|
| ID | 0 | Encode the reference with just the IDs. | |
| Name | 1 | Encode the reference with Names. Where necessary for restoring, the collection type will also be included. | |
| IDThenName | 2 | Encode the reference with both ID and Name, with preference for ID. | |
| NameThenID | 3 | Encode the reference with both Name and ID, with preference for Name. | |
| ShortName | 4 | Encode the reference with just the Name, omitting the collection type. | |
| LongName | 5 | Encode the reference with the Name, and always include the collection type. | |
| FriendlyName | 6 | Encode the reference with friendly Names suitable for messages. |
Remarks
The resulting path when using the ShortName and FriendlyName options
in the AFObjectGetPath methods
is insufficient to restore the object using one of the
AFObjectFindObjects methods.
When encoding with the ID option, parts of the path which are unnecessary for
restoration are omitted.