ldap_parse_vlv_controlW関数 (winldap.h)

ldap_parse_vlv_control関数は、VLV 検索結果の検索と解析に使用されます。

構文

WINLDAPAPI INT LDAPAPI ldap_parse_vlv_controlW(
  [in]  PLDAP         ExternalHandle,
  [in]  PLDAPControlW *Control,
  [out] PULONG        TargetPos,
  [out] PULONG        ListCount,
  [out] PBERVAL       *Context,
  [out] PINT          ErrCode
);

パラメーター

[in] ExternalHandle

LDAP セッション ハンドル。

[in] Control

LDAPControl 構造体の NULL で終わる配列のアドレス。通常、ldap_parse_resultの呼び出しによって取得されます。

[out] TargetPos

BER エンコード応答コントロール (LDAP_CONTROL_VLVRESPONSE) の targetPosition 要素によって提供される、結果セット リスト内のターゲット エントリの数値位置。 このパラメーターが NULL の場合、ターゲット位置は返されません。

[out] ListCount

BER でエンコードされた応答コントロール (LDAP_CONTROL_VLVRESPONSE) の contentCount 要素によって提供される、リスト内のエントリ数のサーバー推定。 このパラメーターが NULL の場合、サイズは返されません。

[out] Context

サーバーによって生成されるコンテキスト識別子。 サーバーがコンテキスト識別子を返さない場合、このパラメーターは NULL に設定されます。 contextp に NULL が渡された場合、コンテキスト識別子は返されません。

[out] ErrCode

BER でエンコードされた応答コントロール (LDAP_CONTROL_VLVRESPONSE) の virtualListViewResult 要素によって提供される VLV 結果コード。 このパラメーターが NULL の場合、結果コードは返されません。

戻り値

この関数は、VLV 結果コントロールが見つかり、正常に解析されたかどうかを示す LDAP エラー コード を返します。 すべて問題がなければLDAP_SUCCESSが返され、ctrls 配列に応答コントロール (LDAP_CONTROL_VLVRESPONSE) が含まれていない場合はLDAP_CONTROL_MISSINGが返され、解析エラーやその他の問題が発生した場合は別の LDAP エラー コードが返されます。

VLV では、次の LDAP 戻り値コードが使用されます。

LDAP_OPERATIONS_ERROR

LDAP_UNWILLING_TO_PERFORM

LDAP_INSUFFICIENT_ACCESS

LDAP_BUSY

LDAP_TIMELIMIT_EXCEEDED

LDAP_ADMINLIMIT_EXCEEDED

LDAP_OTHER

さらに、VLV をサポートするために次の 2 つのコードが追加されています。

解説

このコントロールは、応答コントロール (LDAP_CONTROL_VLVRESPONSE) でサーバーによって返される検索結果を解析します。 コントロールを識別するために、サーバーからクライアントにコンテキスト識別子が渡されます。コントロールは、 ber_bvfreeを呼び出してセッションの終了時に解放する必要があります。

詳細とコード例については、「 LDAP VLV を使用するためのコード例」を参照してください。

Note

winldap.h ヘッダーは、ldap_parse_vlv_controlをエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

   
サポートされている最小のクライアント Windows Vista
サポートされている最小のサーバー Windows Server 2008
対象プラットフォーム Windows
ヘッダー winldap.h
Library Wldap32.lib
[DLL] Wldap32.dll

関連項目

LDAPControl

LDAPVLVInfo

LDAP_CONTROL_VLVREQUEST

LDAP_CONTROL_VLVRESPONSE

LDAP VLV コントロールを使用した検索

ldap_create_sort_control

ldap_create_vlv_control

ldap_search_ext

ldap_search_ext_s