ldap_create_sort_controlW函数 (winldap.h)

ldap_create_sort_control 函数用于将排序键列表的格式设置为搜索控件。 对控件的支持在 LDAP 3 中有效,但是否支持排序控件是否依赖于特定服务器。

语法

WINLDAPAPI ULONG LDAPAPI ldap_create_sort_controlW(
  [in]  PLDAP         ExternalHandle,
  [in]  PLDAPSortKeyW *SortKeys,
  [in]  UCHAR         IsCritical,
  [out] PLDAPControlW *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

注意

winldap.h 标头将ldap_create_sort_control定义为一个别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。 有关详细信息,请参阅函数原型的 约定。

要求

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

另请参阅

Functions

LDAPSortKey

LDAP_SERVER_SORT_OID

ldap_control_free