ActiveDirectoryMembershipProvider.GetUserNameByEmail メソッド

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

ActiveDirectoryMembershipProvider.GetUserNameByEmail メソッド

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

指定した電子メール アドレスに関連付けられているユーザー名を取得します。

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

Visual Basic (宣言)

Public Overrides Function
 GetUserNameByEmail ( _
    email As String _
) As String

Visual Basic (使用法)

Dim instance As ActiveDirectoryMembershipProvider
Dim email As String
Dim returnValue As String

returnValue = instance.GetUserNameByEmail(email)

C#

public override string GetUserNameByEmail (
    string email
)

C++

public:
virtual String^ GetUserNameByEmail (
    String^ email
) override

J#

public String GetUserNameByEmail (
    String email
)

JScript

public override function GetUserNameByEmail
 (
    email : String
) : String

パラメータ

email

検索対象の電子メール アドレス。

戻り値
指定した電子メール アドレスに関連付けられているユーザー名。

例外

例外の種類	条件
ArgumentException	email が 256 文字を超えています。 または トリム後の email が空です。
ProviderException	同じ電子メール アドレスを持つユーザーがデータ ストア内に複数存在し、かつ、RequiresUniqueEmail プロパティ値が true です。

解説

このメソッドは、ユーザーの電子メール アドレスに基づいて Active Directory データ ストアからユーザー名を取得するときに、Membership クラスによって呼び出されます。

同じ電子メール アドレスを持つユーザーがメンバシップ データ ストアに複数存在する場合、最初にヒットしたユーザー名が返されます。データベース内の各電子メール アドレスが一意になるように、アプリケーションの構成ファイルで membership 要素 (ASP.NET 設定スキーマ) 要素の requiresUniqueEmail 属性を true に設定することもできます。

email パラメータ値の先頭と末尾の空白はトリムされます。トリム後の電子メール アドレスが空の場合、ArgumentException がスローされます。電子メール アドレスが null 参照 (Visual Basic では Nothing) の場合は、Active Directory データ ストア内のすべてのユーザー名が検索され、最初のユーザー名が返されます。

ActiveDirectoryMembershipProvider クラスによって実行される検索クエリがディレクトリ サーバーのパフォーマンスに悪影響を与えないことを確認するまでは、本番システムで検索機能を有効にしないことをお勧めします。

重要 :
GetUserNameByEmail メソッドは、EnableSearchMethods プロパティが false に設定されている場合でも実行されます。

ActiveDirectoryMembershipProvider クラスは状態のない Web 環境での使用を意図しているので、基になる System.DirectoryServices API によって公開されるページング最適化処理を使用できません。このため、サイズの大きなディレクトリに対する検索時のページング操作はかなり負荷がかかるので、避ける必要があります。検索操作は常に、接続文字列で構成されたディレクトリ サーバーに対して実行されます。接続文字列でドメインが指定されている場合は、自動選択されたサーバーに対して検索操作が実行されます。プロバイダの検索メソッドでは、グローバル カタログは使用されません。

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

プラットフォーム

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 名前空間
その他の技術情報
メンバシップの概要