AFActiveDirectoryProperties Class
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFActiveDirectoryProperties object is used to get and set
the Active Directory configuration properties used by the PI AF Server
to access contact information.
Inheritance Hierarchy
SystemObject
OSIsoft.AFAFActiveDirectoryProperties
OSIsoft.AFAFActiveDirectoryProperties
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFActiveDirectoryProperties
Public NotInheritable Class AFActiveDirectoryProperties Dim instance As AFActiveDirectoryProperties
public ref class AFActiveDirectoryProperties sealed
[<SealedAttribute>] type AFActiveDirectoryProperties = class end
The AFActiveDirectoryProperties type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AFActiveDirectoryProperties |
Creates an instance of the Active Directory properties.
|
Properties
| Name | Description | |
|---|---|---|
 | AccountName |
The account name used to access Active Directory from the server.
|
| DomainController |
The domain used to access Active Directory.
|
| ImpersonateUser |
Indicates whether the security of the client or server should be used when accessing Active Directory.
|
| ReturnAllPersons |
Indicates whether all types of persons should be returned from Active Directory.
|
| UseGlobalCatalog |
Indicates whether to used the cached global catalog or Active Directory to retrieve users.
|
| UserFolder |
This Active Directory user folder name.
|
Methods
| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| SetAccount |
Set the account used to access Active Directory from the server.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |