ldap_create_page_controlA 函数 (winldap.h)

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

语法

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

参数

[in] ExternalHandle

会话句柄。

[in] PageSize

每页中要返回的条目数。

[in] Cookie

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

[in] IsCritical

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

[out] Control

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

返回值

此函数返回 WINLDAPAPI ULONG LDAPAPI。

注解

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

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

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

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

当不再需要控件时,调用 ldap_control_free

要求

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

请参阅

函数

LDAP_PAGED_RESULT_OID_STRING

ldap_control_free

ldap_parse_page_control

ldap_parse_result

ldap_search_ext

ldap_search_ext_s