Fungsi GetIpForwardEntry2 (netioapi.h)

Artikel
08/25/2023

Fungsi GetIpForwardEntry2 mengambil informasi untuk entri rute IP di komputer lokal.

Sintaks

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpForwardEntry2(
  [in, out] PMIB_IPFORWARD_ROW2 Row
);

Parameter

[in, out] Row

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

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_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	Elemen tidak ditemukan. Kesalahan ini dikembalikan jika antarmuka jaringan yang ditentukan oleh anggota InterfaceLuid atau InterfaceIndex dari struktur MIB_IPFORWARD_ROW2 yang ditunjukkan oleh parameter Baris tidak cocok dengan awalan alamat IP dan keluarga alamat yang ditentukan dalam anggota DestinationPrefix dalam struktur MIB_IPFORWARD_ROW2 .
ERROR_NOT_SUPPORTED	Permintaan tidak didukung. Kesalahan ini dikembalikan jika tidak ada tumpukan IPv4 di komputer lokal dan AF_INET ditentukan dalam keluarga alamat di anggota DestinationPrefixdari MIB_IPFORWARD_ROW2 yang ditunjukkan oleh parameter Baris . Kesalahan ini juga dikembalikan jika tidak ada tumpukan IPv6 di komputer lokal dan AF_INET6 ditentukan untuk keluarga alamat di anggota DestinationPrefix .
Lainnya	Gunakan FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan.

Keterangan

Fungsi GetIpForwardEntry2 didefinisikan pada Windows Vista dan yang lebih baru.

Fungsi GetIpForwardEntry2 digunakan untuk mengambil 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, GetIpForwardEntry2 mengambil properti lain untuk entri rute IP dan mengisi struktur MIB_IPFORWARD_ROW2 yang ditunjukkan oleh parameter Baris .

Offset metrik rute yang ditentukan dalam anggota Metrik dari struktur MIB_IPFORWARD_ROW2 yang diarahkan oleh parameter Baris hanya mewakili bagian dari metrik rute lengkap. Metrik lengkap adalah kombinasi dari metrik rute ini yang ditambahkan ke metrik antarmuka yang ditentukan dalam anggota Metrik dari struktur MIB_IPINTERFACE_ROW antarmuka terkait. Aplikasi dapat mengambil metrik antarmuka dengan memanggil fungsi GetIpInterfaceEntry .

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

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