ldap_modrdnW関数 (winldap.h)
ldap_modrdn関数は、LDAP エントリの相対識別名を変更します。
この関数は古く、以前のバージョンの LDAP との下位互換性のために提供されています。 LDAP 3 以降の場合は、 ldap_rename_ext または ldap_rename_ext_s関数を 使用します。
構文
WINLDAPAPI ULONG LDAPAPI ldap_modrdnW(
[in] LDAP *ExternalHandle,
[in] const PWSTR DistinguishedName,
[out] const PWSTR 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の呼び出しはスレッド セーフです。
注意
winldap.h ヘッダーは、ldap_modrdnをエイリアスとして定義します。これは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | winldap.h |
| Library | Wldap32.lib |
| [DLL] | Wldap32.dll |