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 返回值,例如LDAP_NO_MEMORY或LDAP_PARAM_ERROR。

若要在不再需要控件时释放控件,请调用 ldap_control_free

要求

要求
最低受支持的客户端 Windows Vista
最低受支持的服务器 Windows Server 2008
目标平台 Windows
标头 winldap.h
Library Wldap32.lib
DLL Wldap32.dll

请参阅

函数

LDAPSortKey

LDAP_SERVER_SORT_OID

ldap_control_free