ActiveDirectoryMembershipProvider.EnableSearchMethods プロパティとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

ActiveDirectoryMembershipProvider.EnableSearchMethods プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

検索指向の ActiveDirectoryMembershipProvider のメソッドを使用できるかどうかを示す値を取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 EnableSearchMethods As Boolean

Visual Basic (使用法)

Dim instance As ActiveDirectoryMembershipProvider
Dim value As Boolean

value = instance.EnableSearchMethods

public bool EnableSearchMethods { get;
 }

C++

public:
property bool EnableSearchMethods {
    bool get ();
}

/** @property */
public boolean get_EnableSearchMethods ()

JScript

public function get EnableSearchMethods
 () : boolean

プロパティ値
検索メソッドを使用できる場合は true。それ以外の場合は false。既定値は false です。

例外

例外の種類	条件
InvalidOperationException	ActiveDirectoryMembershipProvider インスタンスが初期化される前に、EnableSearchMethods プロパティにアクセスしようとしました。

解説

Active Directory サーバーの検索はリソースを消費する可能性がある操作なので、EnableSearchMethods プロパティを使用すると、検索指向の ActiveDirectoryMembershipProvider メソッドを無効にできます。EnableSearchMethods プロパティは、アプリケーションの構成ファイル内の membership 要素 (ASP.NET 設定スキーマ) 要素の enableSearchMethods 属性を使用して設定されます。

EnableSearchMethods プロパティが false の場合、次のメソッドは使用できません。

FindUsersByName
FindUsersByEmail
GetAllUsers

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

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

使用例

ActiveDirectoryMembershipProvider インスタンスを構成して Active Directory サーバーでの検索を有効にする Web.config エントリを次のコード例に示します。

<configuration>
  <connectionStrings>
    <add name="ADService" connectionString="LDAP://ldapServer/" />
  </connectionStrings>
  <system.web>
    <membership defaultProvider="AspNetActiveDirectoryMembershipProvider">
      <providers>
        <add name="AspNetActiveDirectoryMembershipProvider" 
          type="System.Web.Security.ActiveDirectoryMembershipProvider, 
          System.Web, Version=2.0.3600, Culture=neutral, 
          PublicKeyToken=b03f5f7f11d50a3a"
          enableSearchMethods="true" />
      </providers>
    </membership>
  </system.web>
</configuration>