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

Статья
27.08.2023

Функция ldap_modrdn изменяет относительное различающееся имя записи LDAP.

Эта функция устарела и обеспечивает обратную совместимость с более ранними версиями LDAP. Для LDAP 3 или более поздней версии используйте функции ldap_rename_ext или ldap_rename_ext_s .

Синтаксис

WINLDAPAPI ULONG LDAPAPI ldap_modrdn(
  [in]  LDAP       *ExternalHandle,
  [in]  const PSTR DistinguishedName,
  [out] const PSTR NewDistinguishedName
);

Параметры

[in] ExternalHandle

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

[in] DistinguishedName

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

[out] NewDistinguishedName

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

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

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

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

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

Имейте в виду, что различные функции ldap_modrdn позволяют изменять только относительное различающееся имя, которое является наименее значимым компонентом различающегося имени объекта. В случае с версией 3 LDAP предоставляет операцию протокола "Изменить различающееся имя", которая обеспечивает более общий доступ к изменению имени. Эта функция доступна путем вызова ldap_rename_ext или ldap_rename_ext_s. Эти функции рекомендуется вместо функции ldap_modrdn , чтобы изменить имя записи.

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

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

Требования


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