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

Статья
08/27/2023

Функция ldap_get_option извлекает текущие значения параметров на уровне сеанса.

Синтаксис

WINLDAPAPI ULONG LDAPAPI ldap_get_option(
  [in]  LDAP *ld,
  [in]  int  option,
  [out] void *outvalue
);

Параметры

[in] ld

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

[in] option

Имя доступного параметра. Дополнительные сведения и список допустимых параметров и их значений см. в следующем разделе Примечаний.

[out] outvalue

Адрес значения параметра. Фактический тип этого параметра зависит от параметра параметра .

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

Если функция выполняется успешно, возвращаемое значение будет LDAP_SUCCESS.

Если функция завершается сбоем, она возвращает код ошибки. Дополнительные сведения см. в разделе Возвращаемые значения.

Дополнительные сведения и описание необязательных параметров, которые применяются к сеансу LDAP, см. в разделе Параметры сеанса. Значение outvalue возвращает указатель на выделенный блок памяти типа, указанного в таблице Параметры сеанса ; Эта память должна быть освобождена с помощью ldap_memfree , если данные больше не требуются, если они явно не указаны в таблице Параметры сеанса , чтобы не освободить возвращенную память.

ПримечаниеLDAP_OPT_ERROR_STRING возвращает указатель на внутреннюю статическую строковую таблицу, и ldap_memfree не следует вызывать при использовании этого параметра сеанса.

Многопоточность. Функция ldap_get_option является потокобезопасной.

Требования


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