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

AF SDK Reference

PISystem.Description Property

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

Namespace:  OSIsoft.AF
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 PISystem
Dim value As String

value = instance.Description

instance.Description = value
public:
virtual property String^ Description {
	String^ get () sealed;
	void set (String^ value) sealed;
}
abstract Description : string with get, set
override Description : string with get, set

Property Value

Type: String
The detailed description of the object. The maximum length of this property is 1000 characters.

Remarks

If not connected to the PI AF Server, 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 PISystem is a AFCollective (the Collective property is not ), then setting this property will save all collective changes to the server.

Version Information

AFSDK


See Also

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