Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

PIServer.Description Property

  • Last UpdatedNov 18, 2025
  • 2 minute read
PIServer.Description Property
Read/write property that provides a more detailed description of the object.

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: String
The detailed description of the object. The maximum length of this property is 1000 characters.

Exceptions

ExceptionCondition
PIVersionNotSupportedExceptionPI 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.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5

See Also

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in