Функция 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 , содержащую результаты.
Возвращаемое значение
Если сервер возвращает пустой файл cookie (без продолжения), значение будет LDAP_NO_RESULTS_RETURNED. В противном случае клиент сообщает о продолжении (дополнительные доступные данные), возвращая LDAP_SUCCESS.
Если функция в противном случае завершается сбоем, она возвращает возвращаемое значение кода ошибки, связанное со сбоем. Дополнительные сведения см. в разделе Возвращаемые значения.
Комментарии
Функция ldap_get_next_page_s является частью интерфейса для простого синхронного разбиения результатов поиска по страницам. Используйте дескриптор поиска, возвращенный при первоначальном вызове ldap_search_init_page , и укажите в параметре PageSize количество записей, возвращаемых на странице. Задайте для PageSize значение 0, чтобы выйти из поиска.
Результаты, возвращаемые из 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 |
| Header | winldap.h |
| Библиотека | Wldap32.lib |
| DLL | Wldap32.dll |