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

2024-03-13

Функция ldap_delete удаляет запись из дерева каталогов.

Синтаксис

WINLDAPAPI ULONG LDAPAPI ldap_deleteA(
  [in] LDAP       *ld,
  [in] const PSTR dn
);

Параметры

[in] ld

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

[in] dn

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

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

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

Если функция завершается сбоем, возвращаемое значение равно –1, а функция задает параметры ошибки сеанса в структуре данных LDAP . Чтобы получить это значение, используйте LdapGetLastError.

Вызовите ldap_delete , чтобы удалить конечную запись из дерева каталогов. Имейте в виду, что LDAP не поддерживает удаление целых поддеревьев в одной операции. Как асинхронная функция ldap_delete возвращает идентификатор сообщения для операции. Вызовите ldap_result с идентификатором сообщения, чтобы получить результат операции. Чтобы отменить асинхронную операцию удаления до ее завершения, вызовите ldap_abandon.

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

Многопоточность. Вызовы ldap_delete являются потокобезопасны при условии, что LdapGetLastError используется для получения фактического кода ошибки сеанса, когда вызов функции возвращает код сбоя -1.

Примечание При подключении к серверу LDAP 2 приложение должно выполнить операцию привязки, вызвав одну из подпрограмм ldap_bind или ldap_simple_bind , прежде чем пытаться выполнить другие операции.

Требования

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