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

Статья
11/20/2024

Функция ldap_create_vlv_control используется для создания элемента управления запросами (LDAP_CONTROL_VLVREQUEST) на сервере.

Синтаксис

WINLDAPAPI INT LDAPAPI ldap_create_vlv_controlA(
  [in]  PLDAP         ExternalHandle,
  [in]  PLDAPVLVInfo  VlvInfo,
  [in]  UCHAR         IsCritical,
  [out] PLDAPControlA *Control
);

Параметры

[in] ExternalHandle

Дескриптор сеанса LDAP, полученный из вызова ldap_init.

[in] VlvInfo

Адрес структуры LDAPVLVInfo , содержимое которой используется для создания значения созданного элемента управления.

[in] IsCritical

Если это значение не равно нулю, созданный элемент управления будет иметь значение "критически важное значение" для TRUE.

[out] Control

Результирующий параметр, назначенный адресу структуры LDAPControl, содержащей элемент управления запросами (LDAP_CONTROL_VLVREQUEST), созданный этой функцией.

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

Функция ldap_create_vlv_control возвращает код ошибки LDAP для указания сбоя или LDAP_SUCCESS в случае успешного выполнения.

Замечания

При проведении поиска VLV клиент должен использовать эту функцию для создания нового элемента управления VLV, который можно включить в запрос поиска, отправленный серверу. Сервер назначит идентификатор контекста для этого поиска VLV, переданный клиенту. По завершении поиска VLV следует использовать ldap_control_free для освобождения элемента управления, возвращаемого ldap_create_vlv_control, и ldap_controls_free для освобождения массива элементов управления, включая элемент управления ответами VLV, возвращаемый ldap_parse_result.

Дополнительные сведения и пример кода для этой функции см. в разделе Пример кода для использования VLV LDAP.

Заметка

Заголовок winldap.h определяет ldap_create_vlv_control как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows Vista
минимальный поддерживаемый сервер	Windows Server 2008
целевая платформа	Виндоус
заголовка	winldap.h
библиотеки	Wldap32.lib
DLL	Wldap32.dll