функция ldap_create_page_control (winldap.h)

Статья
08/27/2023

Используйте функцию ldap_create_page_control , чтобы создать базовый элемент управления для разбиения результатов по страницам. Поддержка элементов управления доступна в LDAP 3, но поддерживается ли элемент управления страницей, зависит от конкретного сервера.

Синтаксис

WINLDAPAPI ULONG LDAPAPI ldap_create_page_control(
  [in]  PLDAP         ExternalHandle,
  [in]  ULONG         PageSize,
  [in]  berval        *Cookie,
  [in]  UCHAR         IsCritical,
  [out] PLDAPControlA *Control
);

Параметры

[in] ExternalHandle

Дескриптор сеанса.

[in] PageSize

Количество записей, возвращаемых на каждой странице.

[in] Cookie

Указатель на структуру бервалов , используемую сервером для определения расположения в результирующем наборе. Это непрозрачная структура, к которому не следует обращаться напрямую. Задайте значение NULL для первого вызова ldap_create_page_control.

[in] IsCritical

Уведомляет сервер о том, является ли этот элемент управления критически важным для поиска.

[out] Control

Указатель на только что созданный элемент управления.

Возвращаемое значение

Эта функция возвращает WINLDAPAPI ULONG LDAPAPI.

Функция ldap_create_page_control создает простой элемент управления страничными результатами. Элемент управления позволяет клиенту указать скорость, с которой сервер LDAP возвращает результаты операции поиска. Это полезно, если клиент имеет ограниченные ресурсы и не может обработать весь результирующий набор из заданного запроса LDAP или если подключение клиента/сервера работает медленно.

Чтобы создать элемент управления страничными результатами, укажите количество записей, возвращаемых на одной странице. Чтобы нормально возвращать результаты, даже если он не поддерживает этот элемент управления, задайте для параметра IsCriticalзначение FALSE.

Эта функция создает элемент управления . Она не проверяет, поддерживает ли сервер его, и, следовательно, не возвращает LDAP_UNAVAILABLE_CRIT_EXTENSION , если сервер не поддерживает элемент управления. Однако он может возвращать другие стандартные возвращаемые значения LDAP, например LDAP_NO_MEMORY или LDAP_PARAM_ERROR.

Когда ldap_create_page_control возвращается успешно, добавьте созданный элемент управления в список серверных элементов управления в вызове ldap_search_ext или ldap_search_ext_s. Когда сервер возвращает первую страницу результатов, вызовите ldap_parse_result , чтобы получить первую страницу результатов.

Вызовите ldap_control_free, когда элемент управления больше не требуется.

Требования


Минимальная версия клиента	Windows Vista
Минимальная версия сервера	Windows Server 2008
Целевая платформа	Windows
Header	winldap.h
Библиотека	Wldap32.lib
DLL	Wldap32.dll