Click or drag to resize
OSIsoft, LLC

PICollectiveMemberDescription 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:
public string Description { get; set; }

Property Value

Type: String
The detailed description of the object. The maximum length of this property is 1000 characters.
PIVersionNotSupportedExceptionPI Data Archive versions before 3.4.375 do not have the ability to set Description.

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.

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 implicitly connected to a primary or non-primary member, i.e. PIServer.Connect or PICollective.SwitchMember. When directly connected to a primary member, setting this property can only be done for the primary and not for other members.

When directly connected to a certain member, getting this property for other members may return unreliable result.

Version Information


Supported in: 2.10.5, 2.10, 2.9.5
See Also