ldap_modrdn2W関数 (winldap.h)
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 エントリの名前を変更するには、 ldap_modrdn2 関数、またはその同期に相当 するldap_modrdn2_sを使用します。
非同期関数として、 ldap_modrdn2 は操作のメッセージ ID を返します。 操作 の結果を 取得するには、メッセージ ID を使用して ldap_result を呼び出します。 非同期追加操作を完了する前に取り消すには、 ldap_abandonを呼び出します。
さまざまな ldap_modrdn 関数を使用すると、オブジェクトの識別名の最下位コンポーネントである相対識別名のみを変更できます。 バージョン 3 で有効な LDAP は識別名の変更プロトコル操作を提供します。これにより、より一般的な名前変更アクセスが可能になります。 この機能は、 ldap_rename_ext または ldap_rename_ext_sを呼び出すことによって使用できます。 これらの関数は、 ldap_modrdn2 関数ではなく、エントリ名を変更することをお勧めします。
マルチスレッド: 関数 呼び出しが -1 エラー コードを返すときに LdapGetLastError を使用して実際のセッション エラー コードを取得する場合、ldap_modrdn2への呼び出しはスレッド セーフです。
注意
winldap.h ヘッダーは、unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとしてldap_modrdn2を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | winldap.h |
| Library | Wldap32.lib |
| [DLL] | Wldap32.dll |