ADS_STATUSENUM列挙 (iads.h)

  • [アーティクル]

ADS_STATUSENUM列挙は、IDirectorySearch::SetSearchPreference メソッドを使用して設定された検索設定の状態を指定します。

構文

typedef enum __MIDL___MIDL_itf_ads_0000_0000_0019 {
  ADS_STATUS_S_OK = 0,
  ADS_STATUS_INVALID_SEARCHPREF,
  ADS_STATUS_INVALID_SEARCHPREFVALUE
} ADS_STATUSENUM;

定数

 
ADS_STATUS_S_OK
値: 0
検索設定が正常に設定されました。
ADS_STATUS_INVALID_SEARCHPREF
ADS_SEARCHPREF_INFO構造体の dwSearchPref メンバーで指定された検索設定が無効です。 検索設定は、 ADS_SEARCHPREF_ENUM 列挙から取得する必要があります。
ADS_STATUS_INVALID_SEARCHPREFVALUE
ADS_SEARCHPREF_INFO構造体の vValue メンバーで指定された値が、対応する検索設定に対して無効です。

注釈

IDirectorySearch::SetSearchPreference メソッドは、dwStatus メンバー ADS_SEARCHPREF_INFO構造体をADS_STATUSENUM値のいずれかに設定して、対応する検索設定の状態を示します。 呼び出し元は、この状態値を使用して、検索を実行するかどうかを決定できます。

有効な検索設定を設定したが、その設定がサポートされていない場合は、 ADS_STATUS_INVALID_SEARCHPREF ステータス値が設定される場合があります。 たとえば、ADS_SEARCHPREF_SORT_ONを設定したが、通信するサーバーが LDAP サーバー側の並べ替えコントロールをサポートしていない場合、ADS_SEARCHPREF_INFO構造体の dwStatus メンバーは IDirectorySearch::SetSearchPreference 呼び出しによってADS_STATUS_INVALID_SEARCHPREFに設定されます。

メモ VBScript はタイプ ライブラリからデータを読み取ることができないため、VBScript アプリケーションは上記で定義したシンボリック定数を認識しません。 代わりに数値定数を使用して、VBScript アプリケーションで適切なフラグを設定する必要があります。 シンボリック定数を適切なプログラミングプラクティスとして使用するには、次のコード例で行うとおり、このような定数の明示的な宣言を記述します。
 

例

次のコード例は、IDirectorySearch::SetSearchPreference メソッドでADS_STATUSENUM列挙を使用して、検索設定の状態を確認する方法を示しています。

/***************************************************************************

    SetAndCheckSearchTimeout()

***************************************************************************/

HRESULT SetAndCheckSearchTimeout(IDirectorySearch *pSearch, 
                                 DWORD dwTimeout, 
                                 ADS_STATUSENUM *pStatus)
{
    if(!pSearch || !pStatus)
    {
        return E_INVALIDARG;
    }
    
    HRESULT hr;
    ADS_SEARCHPREF_INFO SearchPref;

    SearchPref.dwSearchPref = ADS_SEARCHPREF_TIMEOUT;
    SearchPref.vValue.dwType = ADSTYPE_INTEGER;
    SearchPref.vValue.Integer = dwTimeout;
    SearchPref.dwStatus = ADS_STATUS_S_OK;

    hr = pSearch->SetSearchPreference(&SearchPref, 1);
    if(S_OK != hr)
    {
        return hr;
    }

    *pStatus = SearchPref.dwStatus;
    return S_OK;
}

要件

要件 値
サポートされている最小のクライアント Windows Vista
サポートされている最小のサーバー Windows Server 2008
Header iads.h

こちらもご覧ください

ADSI 列挙

ADS_SEARCHPREF_ENUM

ADS_SEARCHPREF_INFO

IDirectorySearch::SetSearchPreference