Fungsi GetIpForwardEntry2

Artikel
03/08/2023

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

Sintaks

NETIOAPI_API GetIpForwardEntry2(
  _Inout_ PMIB_IPFORWARD_ROW2 Row
);

Parameter

Baris [masuk, keluar]
Penunjuk ke entri struktur MIB_IPFORWARD_ROW2 untuk entri rute IP. Saat pengembalian berhasil, struktur ini diperbarui dengan properti untuk entri rute IP.

Mengembalikan nilai

GetIpForwardEntry2 mengembalikan STATUS_SUCCESS jika fungsi berhasil.

Jika fungsi gagal, GetIpForwardEntry2 mengembalikan salah satu kode kesalahan berikut:

Menampilkan kode	Deskripsi
STATUS_INVALID_PARAMETER	Parameter yang tidak valid diteruskan ke fungsi. Kesalahan ini dikembalikan jika salah satu situasi berikut terjadi: Penunjuk NULL diteruskan dalam parameter Baris . Anggota DestinationPrefix dari struktur MIB_IPFORWARD_ROW2 yang ditunjuk parameter Baris tidak ditentukan. Anggota NextHop dari struktur MIB_IPFORWARD_ROW2 tidak ditentukan. Anggota InterfaceLuid dan InterfaceIndex dari struktur MIB_IPFORWARD_ROW2 tidak ditentukan. Anggota PreferredLifetime dari struktur MIB_IPFORWARD_ROW2 lebih besar dari anggota ValidLifetime . Anggota SitePrefixLength dari struktur MIB_IPFORWARD_ROW2 lebih besar dari panjang awalan yang ditentukan oleh anggota DestinationPrefix .
STATUS_NOT_FOUND	Antarmuka yang ditentukan tidak dapat ditemukan. Kesalahan ini dikembalikan jika fungsi tidak dapat menemukan antarmuka jaringan yang ditentukan oleh anggota InterfaceLuid atau InterfaceIndex dari struktur MIB_IPFORWARD_ROW2 yang ditunjuk parameter Baris .
STATUS_NOT_SUPPORTED	Permintaan tidak didukung. Kesalahan ini dikembalikan jika tidak ada tumpukan IPv4 yang terletak di komputer lokal dan AF_INET ditentukan dalam keluarga alamat di anggota DestinationPrefix dari struktur MIB_IPFORWARD_ROW2 yang ditunjuk parameter Baris , atau jika tidak ada tumpukan IPv6 yang terletak di komputer lokal dan AF_INET6 ditentukan untuk keluarga alamat di anggota DestinationPrefix .
Lainnya	Gunakan fungsi FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan.

Keterangan

Fungsi GetIpForwardEntry2 digunakan untuk mengambil entri struktur MIB_IPFORWARD_ROW2 .

Pada input, driver Anda harus menginisialisasi anggota struktur MIB_IPFORWARD_ROW2 berikut yang ditunjuk oleh parameter Baris .

DestinationPrefix
Atur ke awalan alamat dan keluarga IPv4 atau IPv6 yang valid.
NextHop
Atur ke alamat dan keluarga IPv4 atau IPv6 yang valid.
InterfaceLuid atau InterfaceIndex
Anggota ini digunakan dalam urutan yang tercantum sebelumnya. Jadi, jika InterfaceLuid ditentukan, anggota ini digunakan untuk menentukan antarmuka. Jika tidak ada nilai yang ditetapkan untuk anggota InterfaceLuid (nilai anggota ini diatur ke nol), anggota InterfaceIndex berikutnya digunakan untuk menentukan antarmuka.

Pada output, ketika panggilan berhasil, GetIpForwardEntry2 mengambil properti lain untuk entri rute IP dan mengisi struktur MIB_IPFORWARD_ROW2 yang ditunjuk parameter Baris .

Offset metrik rute yang ditentukan dalam anggota Metrik dari struktur MIB_IPFORWARD_ROW2 yang ditunjuk 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. Driver dapat mengambil metrik antarmuka dengan memanggil fungsi GetIpInterfaceEntry .

Driver Anda dapat memanggil fungsi GetIpForwardTable2 untuk menghitung entri rute IP di komputer lokal.

Persyaratan

Platform target	Universal
Versi	Tersedia di Windows Vista dan versi yang lebih baru dari sistem operasi Windows.
Header	Netioapi.h (termasuk Netioapi.h)
Pustaka	Netio.lib
IRQL	< DISPATCH_LEVEL