PIServer.Description Property
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public string Description { get; set; }
Public Property Description As String Get Set Dim instance As PIServer Dim value As String value = instance.Description instance.Description = value
public: property String^ Description { String^ get (); void set (String^ value); }
member Description : string with get, set
Property Value
Type: StringThe detailed description of the object. The maximum length of this property is 1000 characters.
Exceptions
| Exception | Condition |
|---|---|
| PIVersionNotSupportedException | PI Data Archive versions before 3.4.375 do not have the ability to set Description. |
Remarks
If not connected to the PI Data Archive, then accessing this property will NOT automatically connect to the server. When not connected, this property will return a string indicating that it is not currently connected to the server.
If the PIServer is a PICollective (the Collective property is not ), there are restrictions on setting this property. Setting this property cannot be done when directly connected to a non-primary member, i.e. PICollectiveMember.Connect or PICollectiveMember.ConnectDirect. Setting this property can be done when directly connected to a primary member, or when implicitly connected to primary or non-primary member, i.e. PIServer.Connect or PICollective.SwitchMember.