ldap_create_page_controlW函数（winldap.h）

2024-11-20

使用 ldap_create_page_control 函数创建用于分页结果的基本控件。对控件的支持在 LDAP 3 中有效，但页面控件是否受支持依赖于特定服务器。

语法

WINLDAPAPI ULONG LDAPAPI ldap_create_page_controlW(
  [in]  PLDAP         ExternalHandle,
  [in]  ULONG         PageSize,
  [in]  berval        *Cookie,
  [in]  UCHAR         IsCritical,
  [out] PLDAPControlW *Control
);

参数

[in] ExternalHandle

会话句柄。

[in] PageSize

要在每个页面中返回的条目数。

[in] Cookie

指向服务器用来确定其结果集中位置的 berval 结构的指针。这是一个不透明的结构，不应直接访问。设置为 NULL，以便第一次调用 ldap_create_page_control。

[in] IsCritical

通知服务器此控件是否对搜索至关重要。

[out] Control

指向新创建的控件的指针。

返回值

此函数返回 WINLDAPAPI ULONG LDAPAPI。

言论

ldap_create_page_control 函数创建一个简单的分页结果控件。该控件使客户端能够指定 LDAP 服务器返回搜索操作结果的速率。如果客户端的资源有限，并且可能无法处理给定 LDAP 查询的整个结果集，或者客户端/服务器连接速度缓慢，这非常有用。

若要创建分页结果控件，请指定要在单个页面中返回的条目数。若要正常返回结果，即使它不支持此控件，请将 IsCritical 参数设置为 FALSE。

此函数创建控件 - 它不验证服务器是否支持它，因此，如果服务器不支持该控件，则不会返回 LDAP_UNAVAILABLE_CRIT_EXTENSION。但是，它可以返回其他标准 LDAP 返回值，例如 LDAP_NO_MEMORY 或 LDAP_PARAM_ERROR。

成功返回 ldap_create_page_control 时，在调用 ldap_search_ext 或 ldap_search_ext_s时，将新创建的控件包含在服务器控件列表中。当服务器返回结果的第一页时，调用 ldap_parse_result 以检索结果的第一页。

不再需要控件时调用 ldap_control_free。

注意

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

要求

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