Click or drag to resize
OSIsoft, LLC

AFEncodeType Enumeration

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: 2.10.8.440
Syntax
public enum AFEncodeType
Members
  Member nameValueDescription
ID0 Encode the reference with just the IDs.
Name1 Encode the reference with Names. Where necessary for restoring, the collection type will also be included.
IDThenName2 Encode the reference with both ID and Name, with preference for ID.
NameThenID3 Encode the reference with both Name and ID, with preference for Name.
ShortName4 Encode the reference with just the Name, omitting the collection type.
LongName5 Encode the reference with the Name, and always include the collection type.
FriendlyName6 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.
Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5, 2.4
See Also
Enabling Operational Intelligence