AuthenticablePrincipal.Enabled Property

Definition

Namespace:

System.DirectoryServices.AccountManagement

Assembly:

System.DirectoryServices.AccountManagement.dll

Package:

System.DirectoryServices.AccountManagement v9.0.0-rc.2.24473.5

Source:

AuthenticablePrincipal.cs

Gets or sets a Nullable Boolean value that specifies whether this account is enabled for authentication.

public:
 property Nullable<bool> Enabled { Nullable<bool> get(); void set(Nullable<bool> value); };

public bool? Enabled { get; set; }

member this.Enabled : Nullable<bool> with get, set

Public Property Enabled As Nullable(Of Boolean)

Property Value

Nullable<Boolean>

true if the principal is enabled, or null if the account has not been persisted; otherwise false.

Exceptions

InvalidOperationException

The underlying store does not support this property.

ArgumentNullException

The application tried to set a null value for this property.

Remarks

If the principal has not been persisted in the store, this property returns null. After the principal is persisted, the default enabled setting depends on the store. The AD DS and AD LDS stores disable new principals when they are persisted, whereas SAM enables new principals when they are persisted. The application can only set this property to a value after it has been persisted in the store.