ActiveDirectoryMembershipProvider.UnlockUser メソッド

.NET Framework クラス ライブラリ リファレンス

ActiveDirectoryMembershipProvider.UnlockUser メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

ロックを解除して、メンバシップ ユーザーの検証を可能にします。

名前空間: System.Web.Security
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Overrides Function
 UnlockUser ( _
    username As String _
) As Boolean

Visual Basic (使用法)

Dim instance As ActiveDirectoryMembershipProvider
Dim username As String
Dim returnValue As Boolean

returnValue = instance.UnlockUser(username)

C#

public override bool UnlockUser (
    string username
)

C++

public:
virtual bool UnlockUser (
    String^ username
) override

J#

public boolean UnlockUser (
    String username
)

JScript

public override function UnlockUser (
    username : String
) : boolean

パラメータ

username

ロック ステータスを解除するメンバシップ ユーザーの名前。

戻り値
メンバシップ ユーザーのロックが正常に解除された場合は true。それ以外の場合は false。メンバシップ ユーザーがデータ ストアで見つからなかった場合にも、UnlockUser メソッドは false を返します。

例外

例外の種類	条件
ArgumentException	username が空であるか、ユーザー名の許容最大長 (通常は 256 文字) を超えています。 または username はコンマを含んでいます。 または ユーザー名は userPrincipalName にマップされていますが、username パラメータに円記号が含まれています。
ArgumentNullException	username が null 参照 (Visual Basic では Nothing) です。
InvalidOperationException	ActiveDirectoryMembershipProvider インスタンスが初期化される前に UnlockUser メソッドが呼び出されました。

解説

通常、ユーザーがロックアウトされて ValidateUser メソッドで検証できなくなるのは、PasswordAttemptWindow プロパティで指定された時間内に MaxInvalidPasswordAttempts プロパティに指定された回数を超えた場合、または正しくないパスワードを使用してログオンしようとする試みが所定の回数行われた場合です。

EnablePasswordReset プロパティが true の場合、ユーザーのロックが解除されると、無効なパスワードのカウンタがリセットされます。

プロバイダは、接続文字列で指定された検索位置を開始点としてサブツリー検索を実行します。接続文字列の詳細については、ActiveDirectoryMembershipProvider クラスのトピックを参照してください。

username パラメータ値の先頭と末尾の空白はトリムされます。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ActiveDirectoryMembershipProvider クラス
ActiveDirectoryMembershipProvider メンバ
System.Web.Security 名前空間
その他の技術情報
メンバシップの概要