ldap_create_sort_control関数 (winldap.h)
ldap_create_sort_control関数は、並べ替えキーのリストを検索コントロールに書式設定するために使用されます。 LDAP 3 ではコントロールのサポートを有効にできますが、並べ替えコントロールがサポートされているかどうかは、特定のサーバーによって異なります。
構文
WINLDAPAPI ULONG LDAPAPI ldap_create_sort_control(
[in] PLDAP ExternalHandle,
[in] PLDAPSortKeyA *SortKeys,
[in] UCHAR IsCritical,
[out] PLDAPControlA *Control
);
パラメーター
[in] ExternalHandle
セッション ハンドル。
[in] SortKeys
LDAPSortKey 構造体の配列へのポインター。 配列内の各構造体は、並べ替えキーとして使用する属性の名前、そのキーの照合規則、並べ替え順序が昇順か降順かを指定します。
[in] IsCritical
このコントロールが検索に不可欠かどうかをサーバーに通知します。 0 ==> FALSE、!0 ==> TRUE。
[out] Control
新しく作成されたコントロールへのポインター。
戻り値
この関数は、WINLDAPAPI ULONG LDAPAPI を返します。
注釈
ldap_create_sort_control関数は、基本的な並べ替えコントロールを作成します。 このようなコントロールは、LDAP クライアントの機能が制限されていて、結果を並べ替えることができないが、並べ替えが必要な場合に便利です。
並べ替えコントロールを使用すると、サーバーは、検索操作で返される結果コードに依存しない結果の並べ替えの結果コードを返すことができます。
この関数はコントロールを作成します。サーバーがコントロールをサポートしていることを確認しないため、サーバーがコントロールをサポートしていない場合はLDAP_UNAVAILABLE_CRIT_EXTENSIONを返しません。 ただし、LDAP_NO_MEMORYやLDAP_PARAM_ERRORなど、他の標準 LDAP 戻り値を返すことができます。
不要になったときにコントロールを解放するには、 ldap_control_freeを呼び出します。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | winldap.h |
| Library | Wldap32.lib |
| [DLL] | Wldap32.dll |