AFContact.Description Property
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
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 AFContact 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: StringThe detailed description of the object. The maximum length of this property is 1000 characters.
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | This exception is thrown when setting this property if the contact is defined by ActiveDirectory. |
Remarks
Contains the description to display for the contact.
The value of this property is obtained from the
description Microsoft Active Directory attribute.