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

AF SDK Reference

AFContact.CanonicalName Property

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFContact.CanonicalName Property
This property is the canonical name of the contact.

Namespace:  OSIsoft.AF
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public string CanonicalName { get; set; }
Public Property CanonicalName As String
	Get
	Set

Dim instance As AFContact
Dim value As String

value = instance.CanonicalName

instance.CanonicalName = value
public:
property String^ CanonicalName {
	String^ get ();
	void set (String^ value);
}
member CanonicalName : string with get, set

Property Value

Type: String
Returns the canonical name of the contact. The maximum length of this property is 100 characters.

Exceptions

ExceptionCondition
InvalidOperationException This exception is thrown when setting this property if the contact is defined by ActiveDirectory.

Remarks

The name of the contact in canonical format. For example, myserver2.fabrikam.com/users/jeffsmith is a distinguished name in canonical format. The value of this property is obtained from the canonicalName Microsoft Active Directory attribute.

The value of this property can be used when searching for contacts using the FindContact(PISystem, String) or FindContacts Overload method.

Version Information

AFSDK


See Also

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