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

Статья
08/27/2023

Функция ldap_parse_result анализирует ответы сервера и возвращает соответствующие поля.

Синтаксис

WINLDAPAPI ULONG LDAPAPI ldap_parse_result(
  [in]            LDAP          *Connection,
  [in]            LDAPMessage   *ResultMessage,
  [out, optional] ULONG         *ReturnCode,
  [out, optional] PSTR          *MatchedDNs,
  [out, optional] PSTR          *ErrorMessage,
  [out, optional] PSTR          **Referrals,
  [out, optional] PLDAPControlA **ServerControls,
  [in]            BOOLEAN       Freeit
);

Параметры

[in] Connection

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

[in] ResultMessage

Результат операции LDAP, возвращенный одним из вызовов синхронной операции или ldap_result для асинхронной операции.

[out, optional] ReturnCode

Указывает результат операции сервера, создающей исходное результирующий сообщение. Передайте значение NULL , чтобы игнорировать это поле.

[out, optional] MatchedDNs

Указатель на широкую строку с пустым завершением. В случае возврата LDAP_NO_SUCH_OBJECT этот результирующий параметр заполняется различающимся именем, указывающим, какая часть имени в запросе была распознана. Передайте значение NULL , чтобы игнорировать это поле.

[out, optional] ErrorMessage

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

[out, optional] Referrals

Указатель на широкую строку с пустым завершением, которая содержит содержимое поля рефералов из параметра ResultMessage , указывающее на ноль или более альтернативных серверов LDAP, на которых следует повторно выполнить запрос. Передайте значение NULL , чтобы игнорировать это поле.

[out, optional] ServerControls

Этот результирующий параметр заполняется выделенным массивом элементов управления, скопированных из параметра ResultMessage .

[in] Freeit

Определяет, освобожден ли параметр ResultMessage . Вы можете передать любое ненулевое значение параметру Freeit , чтобы освободить указатель ResultMessage , когда он больше не нужен, или вызвать ldap_msgfree , чтобы освободить результат позже.

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

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

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

Функция ldap_parse_result проходит цепочку ответов сервера, которые ищут результирующих сообщений для анализа. Используйте эту функцию, если вы хотите получить доступ к рефералам, сопоставлению различающихся имен или возвращенным элементам управления сервера. Функция пропускает сообщения типа LDAP_RES_SEARCH_ENTRY и LDAP_RES_SEARCH_REFERENCE.

Если они больше не нужны, освободите строки ErrorMessage и MatchedDNs , вызвав ldap_memfree. Освободите массив Ссылок , вызвав ldap_value_free. Освободите ServerControls , вызвав ldap_controls_free.

Требования


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