ldap_create_vlv_controlW関数 (winldap.h)
ldap_create_vlv_control関数は、サーバー上に要求コントロール (LDAP_CONTROL_VLVREQUEST) を作成するために使用されます。
構文
WINLDAPAPI INT LDAPAPI ldap_create_vlv_controlW(
[in] PLDAP ExternalHandle,
[in] PLDAPVLVInfo VlvInfo,
[in] UCHAR IsCritical,
[out] PLDAPControlW *Control
);
パラメーター
[in] ExternalHandle
ldap_initの呼び出しから取得された LDAP セッション ハンドル。
[in] VlvInfo
作成されたコントロールの値を構築するために内容が使用される LDAPVLVInfo 構造体のアドレス。
[in] IsCritical
この値が 0 でない場合、作成されたコントロールの重要度は TRUE に設定されます。
[out] Control
結果パラメーターには、この関数によって作成された要求制御 (LDAP_CONTROL_VLVREQUEST) を含む LDAPControl 構造体のアドレスが割り当てられます。
戻り値
ldap_create_vlv_control関数は、エラーを示す LDAP エラー コードを返します。成功した場合はLDAP_SUCCESS。
注釈
VLV 検索を実行する場合、クライアントはこの関数を使用して、サーバーに送信される検索要求に含めることができる新しい VLV コントロールを作成する必要があります。 サーバーは、クライアントに渡されるこの VLV 検索の contextID を割り当てます。 VLV 検索が完了したら、ldap_control_freeを使用して 、ldap_create_vlv_control によって返されたコントロールを解放し、 ldap_controls_freeして、 ldap_parse_result によって返される VLV 応答コントロールを含むコントロールの配列 を解放する必要があります。
詳細とこの関数のコード例については、「 LDAP VLV を使用するためのコード例」を参照してください。
注意
winldap.h ヘッダーは、ldap_create_vlv_controlをエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista |
サポートされている最小のサーバー | Windows Server 2008 |
対象プラットフォーム | Windows |
ヘッダー | winldap.h |
Library | Wldap32.lib |
[DLL] | Wldap32.dll |