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 終止陣列，表示每個相符項目要傳回的屬性。 傳遞 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 以釋放此結構和其句柄。
若要判斷伺服器是否支援分頁結果搜尋，請檢查根標識符的 supportedControl 屬性， (OID) 1.2.840.113556.1.4.319。
規格需求
| 需求 | 值 |
|---|---|
| 最低支援的用戶端 | Windows Vista |
| 最低支援的伺服器 | Windows Server 2008 |
| 目標平台 | Windows |
| 標頭 | winldap.h |
| 程式庫 | Wldap32.lib |
| Dll | Wldap32.dll |