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

Статья
27.08.2023

Функция ldap_search_init_page инициализирует блок поиска для простого поиска по страницам. Эта функция поддерживается в LDAP 3.

Синтаксис

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

Параметры

[in] ExternalHandle

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

[in] DistinguishedName

Указатель на строку, завершающуюся нулевым значением, которая содержит различающееся имя записи, с которой начинается поиск.

[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 , чтобы освободить эту структуру и ее дескриптор.

Чтобы определить, поддерживает ли сервер поиск по страницам, проверка свойство supportedControl вне корневого каталога идентификатора объекта (OID) 1.2.840.113556.1.4.319.

Требования


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