ldap_get_next_page_s 函数 (winldap.h)

ldap_get_next_page_s 函数返回同步分页搜索结果序列中的下一页。

语法

WINLDAPAPI ULONG LDAPAPI ldap_get_next_page_s(
  [in]  PLDAP       ExternalHandle,
  [in]  PLDAPSearch SearchHandle,
  [in]  l_timeval   *timeout,
  [in]  ULONG       PageSize,
  [out] ULONG       *TotalCount,
  [out] LDAPMessage **Results
);

参数

[in] ExternalHandle

会话句柄。

[in] SearchHandle

搜索块句柄。

[in] timeout

客户端将等待调用返回的时间值(以秒为单位)。

[in] PageSize

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

[out] TotalCount

服务器对整个结果集中条目总数的估计值。 值为零表示服务器无法提供估计值。

[out] Results

指向包含结果的 LDAPMessage 结构的指针。

返回值

如果服务器 (非延续) 返回 null Cookie,则值为 LDAP_NO_RESULTS_RETURNED。 否则,客户端通过返回LDAP_SUCCESS (更多可用数据) 发出信号。

如果函数失败,它将返回与失败相关的错误代码返回值。 有关详细信息,请参阅 返回值

注解

ldap_get_next_page_s 函数是用于对搜索结果进行简单同步分页的接口的一部分。 使用从初始调用返回的搜索句柄 ldap_search_init_page 并在 PageSize 参数中指定要在页面中返回的条目数。 将 PageSize 设置为零以退出搜索。

ldap_get_next_page_s 返回的结果可以作为任何其他搜索结果进行处理,完成后应通过调用 ldap_msgfree释放。

分析结果集时,服务器可能会返回结果的空页,但仍使用 LDAP_SUCCESS 返回代码进行响应。 这表示服务器由于超时或其他原因而无法检索结果页,但尚未完成搜索请求。 此实例中的正确行为是继续调用 ldap_get_next_page_s ,直到成功检索另一页结果、返回错误代码或返回 LDAP_NO_RESULTS_RETURNED 以指示搜索已完成。

若要异步检索分页搜索结果,请使用 ldap_get_next_page

如果使用 ldap_get_next_page_s ,则不需要调用 ldap_get_paged_count 来记录服务器返回的分页结果数。

要求

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

请参阅

函数

LDAPMessage

返回值

ldap_get_next_page

ldap_get_paged_count

ldap_msgfree

ldap_search_init_page