ldap_get_next_page 函数 (winldap.h)
ldap_get_next_page函数返回异步分页搜索结果序列中的下一页。
语法
WINLDAPAPI ULONG LDAPAPI ldap_get_next_page(
[in] PLDAP ExternalHandle,
[in] PLDAPSearch SearchHandle,
[in] ULONG PageSize,
[out] ULONG *MessageNumber
);
参数
[in] ExternalHandle
会话句柄。
[in] SearchHandle
搜索块句柄。
[in] PageSize
在单个页面中返回的条目数。
[out] MessageNumber
请求的消息 ID。
返回值
如果函数成功,则返回值 LDAP_SUCCESS。
如果函数失败,它将返回错误代码返回值。 有关详细信息,请参阅 返回值。
注解
ldap_get_next_page 函数是用于对搜索结果进行简单异步分页的接口的一部分。 使用从初始调用返回的搜索句柄 ldap_search_init_page 并在 PageSize 参数中指定要在页面中返回的条目数。 将 PageSize 设置为零可放弃搜索。
请注意,每次调用 ldap_get_next_page 后,必须使用 ldap_result 为服务器返回的每组结果调用 ldap_get_paged_count。 这使 LDAP 运行时能够保存服务器传递回的 Cookie 以保持搜索状态。 除了调用 ldap_get_paged_count之外, 从ldap_get_next_page 返回的结果可以像任何其他搜索结果一样处理,并且必须在完成时通过调用 ldap_msgfree来释放。
分析结果集时,请注意,服务器可能会返回结果的空页,但仍使用 LDAP_SUCCESS 返回值进行响应。 这表示服务器由于超时或其他原因而无法检索结果页,但尚未完成搜索请求。 在此实例中,正确行为是继续调用 ldap_get_next_page ,直到成功检索另一页结果、返回错误代码或返回 LDAP_NO_RESULTS_RETURNED 以指示搜索已完成。
如果希望同步检索分页搜索结果,请使用 ldap_get_next_page_s。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows Vista |
最低受支持的服务器 | Windows Server 2008 |
目标平台 | Windows |
标头 | winldap.h |
Library | Wldap32.lib |
DLL | Wldap32.dll |
请参阅
返回值