Fungsi DeleteUnicastIpAddressEntry (netioapi.h)

Artikel
08/25/2023

Fungsi DeleteUnicastIpAddressEntry menghapus entri alamat IP unicast yang ada di komputer lokal.

Sintaks

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API DeleteUnicastIpAddressEntry(
  [in] const MIB_UNICASTIPADDRESS_ROW *Row
);

Parameter

[in] Row

Penunjuk ke entri struktur MIB_UNICASTIPADDRESS_ROW untuk entri alamat IP unicast yang ada untuk dihapus dari komputer lokal.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan adalah NO_ERROR.

Jika fungsi gagal, nilai yang dikembalikan adalah salah satu kode kesalahan berikut.

Menampilkan kode	Deskripsi
ERROR_ACCESS_DENIED	Akses ditolak. Kesalahan ini dikembalikan dalam beberapa kondisi yang mencakup hal berikut: pengguna tidak memiliki hak istimewa administratif yang diperlukan di komputer lokal atau aplikasi tidak berjalan dalam shell yang ditingkatkan sebagai Administrator bawaan (administrator RunAs).
ERROR_INVALID_PARAMETER	Parameter yang tidak valid diteruskan ke fungsi. Kesalahan ini dikembalikan jika penunjuk NULL diteruskan dalam parameter Baris , anggota AlamatMIB_UNICASTIPADDRESS_ROW yang ditunjukkan oleh parameter Baris tidak diatur ke alamat IPv4 atau IPv6 unicast yang valid, atau anggota InterfaceLuid atau InterfaceIndexdari MIB_UNICASTIPADDRESS_ROW yang ditunjukkan oleh parameter Baris tidak ditentukan.
ERROR_NOT_FOUND	Antarmuka yang ditentukan tidak dapat ditemukan. Kesalahan ini dikembalikan jika antarmuka jaringan yang ditentukan oleh anggota InterfaceLuid atau InterfaceIndexdari MIB_UNICASTIPADDRESS_ROW yang ditunjukkan oleh parameter Baris tidak dapat ditemukan.
ERROR_NOT_SUPPORTED	Permintaan tidak didukung. Kesalahan ini dikembalikan jika tidak ada tumpukan IPv4 di komputer lokal dan alamat IPv4 ditentukan di anggota AlamatMIB_UNICASTIPADDRESS_ROW ditunjukkan oleh parameter Baris . Kesalahan ini juga dikembalikan jika tidak ada tumpukan IPv6 di komputer lokal dan alamat IPv6 ditentukan di anggota Alamat .
Lainnya	Gunakan FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan.

Keterangan

Fungsi DeleteUnicastIpAddressEntry didefinisikan pada Windows Vista dan yang lebih baru.

Fungsi DeleteUnicastIpAddressEntry digunakan untuk menghapus entri struktur MIB_UNICASTIPADDRESS_ROW yang ada di komputer lokal.

Pada input, anggota Alamat dalam struktur MIB_UNICASTIPADDRESS_ROW yang ditunjukkan oleh parameter Baris harus diatur ke alamat dan keluarga IPv4 atau IPv6 unicast yang valid. Selain itu, setidaknya salah satu anggota berikut dalam struktur MIB_UNICASTIPADDRESS_ROW yang menunjuk ke parameter Baris harus diinisialisasi: InterfaceLuid atau InterfaceIndex.

Bidang digunakan dalam urutan yang tercantum di atas. Jadi, jika InterfaceLuid ditentukan, maka anggota ini digunakan untuk menentukan antarmuka. Jika tidak ada nilai yang ditetapkan untuk anggota InterfaceLuid (nilai anggota ini diatur ke nol), maka anggota InterfaceIndex berikutnya digunakan untuk menentukan antarmuka.

Jika fungsi berhasil, alamat IP yang ada yang diwakili oleh parameter Baris dihapus.

Fungsi GetUnicastIpAddressTable dapat dipanggil untuk menghitung entri alamat IP unicast di komputer lokal. Fungsi GetUnicastIpAddressEntry dapat dipanggil untuk mengambil entri alamat IP unicast tertentu yang ada.

Fungsi DeleteUnicastIpAddressEntry hanya dapat dipanggil oleh pengguna yang masuk sebagai anggota grup Administrator. Jika DeleteUnicastIpAddressEntry dipanggil oleh pengguna yang bukan anggota grup Administrator, panggilan fungsi akan gagal dan ERROR_ACCESS_DENIED dikembalikan. Fungsi ini juga dapat gagal karena kontrol akun pengguna (UAC) pada Windows Vista dan yang lebih baru. Jika aplikasi yang berisi fungsi ini dijalankan oleh pengguna yang masuk sebagai anggota grup Administrator selain Administrator bawaan, panggilan ini akan gagal kecuali aplikasi telah ditandai dalam file manifes dengan requestedExecutionLevel yang diatur ke requireAdministrator. Jika aplikasi tidak memiliki file manifes ini, pengguna yang masuk sebagai anggota grup Administrator selain Administrator bawaan kemudian harus menjalankan aplikasi dalam shell yang ditingkatkan sebagai Administrator bawaan (administrator RunAs) agar fungsi ini berhasil.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2008 [hanya aplikasi desktop]
Target Platform	Windows
Header	netioapi.h (termasuk Iphlpapi.h)
Pustaka	Iphlpapi.lib
DLL	Iphlpapi.dll