Fungsi DeleteIpForwardEntry2 (netioapi.h)

Artikel
03/15/2023

Fungsi DeleteIpForwardEntry2 menghapus entri rute IP di komputer lokal.

Sintaks

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API DeleteIpForwardEntry2(
  [in] const MIB_IPFORWARD_ROW2 *Row
);

Parameter

[in] Row

Penunjuk ke entri struktur MIB_IPFORWARD_ROW2 untuk entri rute IP. Pada pengembalian yang berhasil, entri ini akan dihapus.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan 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 DestinationPrefix dari MIB_IPFORWARD_ROW2 yang ditunjukkan oleh parameter Baris tidak ditentukan, anggota NextHop dari MIB_IPFORWARD_ROW2 yang ditunjukkan oleh parameter Baris tidak ditentukan, atau anggota InterfaceLuid atau InterfaceIndexdari MIB_IPFORWARD_ROW2 ditunjukkan oleh Baris parameter 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_IPFORWARD_ROW2 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 dalam anggota AlamatMIB_IPFORWARD_ROW2 yang ditunjukkan oleh parameter Baris . Kesalahan ini juga dikembalikan jika tidak ada tumpukan IPv6 di komputer lokal dan alamat IPv6 ditentukan dalam anggota Alamat .
Lainnya	Gunakan FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan.

Keterangan

Fungsi DeleteIpForwardEntry2 ditentukan pada Windows Vista dan yang lebih baru.

Fungsi DeleteIpForwardEntry2 digunakan untuk menghapus entri struktur MIB_IPFORWARD_ROW2 .

Pada input, anggota DestinationPrefix dalam struktur MIB_IPFORWARD_ROW2 yang ditunjukkan oleh parameter Baris harus diinisialisasi ke awalan alamat dan keluarga IPv4 atau IPv6 yang valid. Pada input, anggota NextHop dalam struktur MIB_IPFORWARD_ROW2 yang ditunjukkan oleh parameter Baris harus diinisialisasi ke alamat dan keluarga IPv4 atau IPv6 yang valid. Selain itu, setidaknya salah satu anggota berikut dalam struktur MIB_IPFORWARD_ROW2 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 selanjutnya digunakan untuk menentukan antarmuka.

Pada output saat panggilan berhasil, DeleteIpForwardEntry2 menghapus entri rute IP.

Fungsi DeleteIpForwardEntry2 akan gagal jika anggota DestinationPrefix dan NextHopdari MIB_IPFORWARD_ROW2 yang diarahkan oleh parameter Baris tidak cocok dengan entri rute IP yang ada pada antarmuka yang ditentukan dalam anggota InterfaceLuid atau InterfaceIndex .

Fungsi GetIpForwardTable2 dapat dipanggil untuk menghitung entri rute IP di komputer lokal.

Fungsi DeleteIpForwardEntry2 hanya dapat dipanggil oleh pengguna yang masuk sebagai anggota grup Administrator. Jika DeleteIpForwardEntry2 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 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