fungsi ldap_modrdnW (winldap.h)

Artikel
11/20/2024

Fungsi ldap_modrdn mengubah nama relatif khusus entri LDAP.

Fungsi ini usang dan disediakan untuk kompatibilitas mundur dengan versi LDAP yang lebih lama. Untuk LDAP 3 atau yang lebih baru, gunakan fungsi ldap_rename_ext atau ldap_rename_ext_s.

Sintaksis

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

Parameter

[in] ExternalHandle

Handel sesi.

[in] DistinguishedName

Penunjuk ke string yang dihentikan null yang berisi nama khusus entri yang akan diubah.

[out] NewDistinguishedName

Penunjuk ke string yang dihentikan null yang berisi nama khusus relatif baru untuk memberikan entri.

Mengembalikan nilai

Jika fungsi berhasil, fungsi akan mengembalikan ID pesan dari operasi modifikasi.

Jika fungsi gagal, fungsi mengembalikan –1 dan mengatur parameter kesalahan sesi dalam struktur data LDAP.

Komentar

Gunakan fungsi ldap_modrdn, atau yang setara sinkron, ldap_modrdn_s, untuk mengubah nama entri LDAP. LDAP 2 mendukung fitur tambahan melalui ldap_modrdn2 dan ldap_modrdn2_s.

Sebagai fungsi asinkron, ldap_modrdn mengembalikan ID pesan untuk operasi. Panggil ldap_result dengan ID pesan untuk mendapatkan hasil operasi. Untuk membatalkan operasi penambahan asinkron sebelum selesai, panggil ldap_abandon.

Ketahuilah bahwa berbagai fungsi ldap_modrdn memungkinkan Anda untuk hanya mengubah nama yang dibedakan relatif, yang merupakan komponen paling tidak signifikan dari nama khusus objek. Efektif dengan versi 3, LDAP menyediakan operasi protokol Ubah Nama Khusus yang memungkinkan akses perubahan nama yang lebih umum. Fitur ini tersedia dengan memanggil ldap_rename_ext atau ldap_rename_ext_s. Fungsi-fungsi ini direkomendasikan, alih-alih fungsi ldap_modrdn, untuk mengubah nama entri.

Multithreading: Panggilan ke ldap_modrdn aman utas, asalkan LdapGetLastError digunakan untuk mengambil kode kesalahan sesi aktual saat panggilan fungsi mengembalikan kode kegagalan -1.

Catatan Saat menyambungkan ke server LDAP 2, aplikasi harus melakukan operasi pengikatan, dengan memanggil salah satu rutinitas ldap_bind atau ldap_simple_bind, sebelum mencoba operasi lain. ldap_modrdn usang dan disediakan hanya untuk kompatibilitas dengan implementasi LDAP 1.

Nota

Header winldap.h mendefinisikan ldap_modrdn sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta preprosedur UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Syarat	Nilai
klien minimum yang didukung	Windows Vista
server minimum yang didukung	Windows Server 2008
Platform Target	Windows
Header	winldap.h
Pustaka	Wldap32.lib
DLL	Wldap32.dll