ldap_parse_vlv_controlA関数 (winldap.h)
ldap_parse_vlv_control関数は、VLV 検索結果を検索して解析するために使用されます。
構文
WINLDAPAPI INT LDAPAPI ldap_parse_vlv_controlA(
[in] PLDAP ExternalHandle,
[in] PLDAPControlA *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 を使用するためのコード例」を参照してください。
注意
winldap.h ヘッダーは、ldap_parse_vlv_controlをエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | winldap.h |
| Library | Wldap32.lib |
| [DLL] | Wldap32.dll |