ldap_search_init_page 函数 (winldap.h)

ldap_search_init_page 函数初始化简单分页结果搜索的搜索块。 LDAP 3 支持此函数。

语法

WINLDAPAPI PLDAPSearch LDAPAPI ldap_search_init_page(
  [in] PLDAP        ExternalHandle,
  [in] const PSTR   DistinguishedName,
  [in] ULONG        ScopeOfSearch,
  [in] const PSTR   SearchFilter,
  [in] PZPSTR       AttributeList,
  [in] ULONG        AttributesOnly,
  [in] PLDAPControl *ServerControls,
  [in] PLDAPControl *ClientControls,
  [in] ULONG        PageTimeLimit,
  [in] ULONG        TotalSizeLimit,
  [in] PLDAPSortKey *SortKeys
);

参数

[in] ExternalHandle

会话句柄。

[in] DistinguishedName

指向以 null 结尾的字符串的指针，该字符串包含要开始搜索的条目的可分辨名称。

[in] ScopeOfSearch

一种数据类型，指定以下值之一来指示搜索范围。

LDAP_SCOPE_BASE

仅搜索基本条目。

LDAP_SCOPE_ONELEVEL

搜索基础条目下方第一级的所有条目，不包括基条目。

LDAP_SCOPE_SUBTREE

搜索基项和基下方树中的所有条目。

[in] SearchFilter

指向以 null 结尾的字符串的指针，该字符串指定搜索筛选器。 有关详细信息，请参阅 搜索筛选器语法。

[in] AttributeList

以 null 结尾的字符串数组，指示要为每个匹配项返回哪些属性。 传递 NULL 以检索所有可用属性。

[in] AttributesOnly

一个布尔值，如果同时返回属性类型和值，则应为零;如果只返回类型，则为非零值。

[in] ServerControls

LDAP 服务器控件的列表。

[in] ClientControls

客户端控件的列表。

[in] PageTimeLimit

客户端等待服务器返回页的时间值（以秒为单位）。

[in] TotalSizeLimit

客户端将接受的最大条目数。 TotalSizeLimit 值仅影响分页搜索中的各个页面， (不会影响整个分页搜索) 。 因此，如果 TotalSizeLimit 大于页面大小，则 TotalSizeLimit 将不起作用。

[in] SortKeys

指向 LDAPSortKey 结构的指针，该结构指定属性类型、排序规则和搜索方向。

返回值

如果函数成功，它将返回指向 LDAPSearch 结构的指针。

如果函数失败，则返回值为 NULL。 使用 LdapGetLastError 或 GetLastError 检索错误代码。

调用 ldap_search_abandon_page 以释放返回的结构。

注解

ldap_search_init_page 函数创建用于管理分页搜索的 LDAPSearch 结构，并返回结构的句柄。 ldap_get_next_page、ldap_get_next_page_s 和 ldap_get_paged_count 函数需要此搜索句柄作为参数。 分页搜索完成后，调用 ldap_search_abandon_page 以释放此结构及其句柄。

若要确定服务器是否支持分页结果搜索，检查 OID) 1.2.840.113556.1.4.319 的对象标识符的根 (supportedControl 属性。

要求

请参阅

函数

GetLastError

LDAPSearch

LDAPSortKey

LdapGetLastError

ldap_get_next_page

ldap_get_next_page_s

ldap_search_abandon_page