ldap_modrdn 関数 (winldap.h)
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 で終わる文字列へのポインター。
戻り値
関数が成功すると、変更操作のメッセージ ID が返されます。
関数が失敗した場合、-1 が返され、LDAP データ構造のセッション エラー パラメーターが設定されます。
解説
LDAP エントリの名前を変更するには、 ldap_modrdn 関数、またはその同期に相当 するldap_modrdn_sを使用します。 LDAP 2 では、 ldap_modrdn2 と ldap_modrdn2_sによる追加機能がサポートされています。
非同期関数として、 ldap_modrdn は操作のメッセージ ID を返します。 操作 の結果を 取得するには、メッセージ ID を使用して ldap_result を呼び出します。 非同期追加操作を完了する前に取り消すには、 ldap_abandonを呼び出します。
さまざまな ldap_modrdn 関数を使用すると、オブジェクトの識別名の最下位コンポーネントである相対識別名のみを変更できます。 バージョン 3 で有効な LDAP は、より一般的な名前変更アクセスを可能にする識別名の変更プロトコル操作を提供します。 この機能は、 ldap_rename_ext または ldap_rename_ext_sを呼び出すことによって使用できます。 これらの関数は、 ldap_modrdn 関数ではなく、エントリ名を変更することをお勧めします。
マルチスレッド: 関数 呼び出しが -1 エラー コードを返すときに LdapGetLastError を使用して実際のセッション エラー コードを取得する場合、ldap_modrdnへの呼び出しはスレッド セーフです。
要件
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | winldap.h |
| Library | Wldap32.lib |
| [DLL] | Wldap32.dll |