AF SDK Reference

PIServer.UniqueID Property

Save PDF

TABLE OF CONTENTS

PIServer.UniqueID Property

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Read-only property that provides the PIServer's unique identifier as a String.

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

Syntax

public override string UniqueID { get; }

Public Overrides ReadOnly Property UniqueID As String
	Get

Dim instance As PIServer
Dim value As String

value = instance.UniqueID

public:
virtual property String^ UniqueID {
	String^ get () override;
}

abstract UniqueID : string with get
override UniqueID : string with get

Property Value

Type: String
The PIServer's unique identifier as a String.

Remarks

Normally this is the PIServer's ID property returned as a String. A PIServer can be configured to return an integer as its unique identifier. In this configuration, the ID property will return the integer identifier in Guid format and this property will return the identifier as configured in the PIServer. If the PIServer has never been connected and thus the UniqueID is not known, this will return an empty string.

AF SDK Reference