ldap_modrdn2 函数更改 LDAP 条目的相对可分辨名称。
此函数已过时。 对于 LDAP 3 或更高版本,请使用 ldap_rename_ext 或 ldap_rename_ext_s 函数。
语法
WINLDAPAPI ULONG LDAPAPI ldap_modrdn2W(
[in] LDAP *ExternalHandle,
[in] const PWSTR DistinguishedName,
[in] const PWSTR NewDistinguishedName,
[in] INT DeleteOldRdn
);
参数
[in] ExternalHandle
会话句柄。
[in] DistinguishedName
一个以 null 结尾的字符串,其中包含要更改的可分辨名称。
[in] NewDistinguishedName
一个以 null 结尾的字符串,其中包含要为条目提供的新相对可分辨名称。
[in] DeleteOldRdn
如果应删除旧的相对可分辨名称,则 TRUE;如果应保留旧的相对可分辨名称,FALSE。
返回值
如果函数成功,它将返回修改操作的消息 ID。
如果函数失败,它将返回 –1,并在 LDAP 数据结构中设置会话错误参数。
言论
使用 ldap_modrdn2 函数或其同步等效函数 ldap_modrdn2_s更改 LDAP 条目的名称。
作为异步函数,ldap_modrdn2 返回操作的消息 ID。 使用消息 ID 调用 ldap_result 以获取操作的结果。 若要在完成之前取消异步添加操作,请调用 ldap_abandon。
请注意,各种 ldap_modrdn 函数使你只能更改相对可分辨名称,这是对象可分辨名称中最不重要的部分。 在版本 3 中有效,LDAP 提供“修改可分辨名称”协议操作,这可实现更常规的名称更改访问。 可以通过调用 ldap_rename_ext 或 ldap_rename_ext_s来使用此功能。 建议使用这些函数,而不是 ldap_modrdn2 函数来更改条目名称。
多线程处理:调用 ldap_modrdn2 是线程安全的,前提是 LdapGetLastError 用于在函数调用返回 -1 失败代码时检索实际会话错误代码。
注意
winldap.h 标头将ldap_modrdn2定义为一个别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。 有关详细信息,请参阅函数原型的
要求
要求 | 价值 |
---|---|
最低支持的客户端 | Windows Vista |
支持的最低服务器 | Windows Server 2008 |
目标平台 | 窗户 |
标头 | winldap.h |
库 | Wldap32.lib |
DLL | Wldap32.dll |