Fungsi GetIpPathEntry (netioapi.h)

Artikel
03/15/2023

Fungsi GetIpPathEntry mengambil informasi untuk entri jalur IP di komputer lokal.

Sintaks

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpPathEntry(
  [in, out] PMIB_IPPATH_ROW Row
);

Parameter

[in, out] Row

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

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_FILE_NOT_FOUND	Sistem tidak dapat menemukan file yang ditentukan. Kesalahan ini dikembalikan jika antarmuka jaringan LUID atau indeks antarmuka yang ditentukan oleh anggota InterfaceLuid atau InterfaceIndexdari MIB_IPPATH_ROW yang ditunjukkan oleh parameter Baris bukan nilai pada komputer lokal.
ERROR_INVALID_PARAMETER	Parameter salah. Kesalahan ini dikembalikan jika penunjuk NULL diteruskan dalam parameter Baris , anggota si_family di anggota TujuanMIB_IPPATH_ROW yang ditunjukkan oleh parameter Baris tidak diatur ke AF_INET atau AF_INET6, atau anggota InterfaceLuid atau InterfaceIndex dari MIB_IPPATH_ROW yang diarahkan oleh parameter Baris tidak ditentukan. Kesalahan ini juga dikembalikan jika anggota si_family di anggota SumberMIB_IPPATH_ROW yang ditunjukkan oleh parameter Baris tidak cocok dengan keluarga alamat IP tujuan dan si_family untuk alamat IP sumber tidak ditentukan sebagai AF_UNSPEC.
ERROR_NOT_FOUND	Elemen tidak ditemukan. Kesalahan ini dikembalikan jika antarmuka jaringan yang ditentukan oleh anggota InterfaceLuid atau InterfaceIndex dari struktur MIB_IPPATH_ROW yang ditunjukkan oleh parameter Baris tidak cocok dengan alamat IP dan keluarga alamat yang ditentukan dalam anggota Tujuan dalam struktur MIB_IPPATH_ROW .
ERROR_NOT_SUPPORTED	Permintaan tidak didukung. Kesalahan ini dikembalikan jika tidak ada tumpukan IPv4 di komputer lokal dan alamat IPv4 ditentukan dalam anggota Sumber dan Tujuandari MIB_IPPATH_ROW yang ditunjukkan oleh parameter Baris . Kesalahan ini juga dikembalikan jika tidak ada tumpukan IPv6 di komputer lokal dan alamat IPv6 ditentukan dalam anggota Sumber dan Tujuan .
Lainnya	Gunakan FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan.

Keterangan

Fungsi GetIpPathEntry didefinisikan pada Windows Vista dan yang lebih baru.

Fungsi GetIpPathEntry digunakan untuk mengambil entri struktur MIB_IPPATH_ROW .

Pada input, anggota Tujuan dalam struktur MIB_IPPATH_ROW yang ditunjukkan oleh parameter Baris harus diinisialisasi ke alamat dan keluarga IPv4 atau IPv6 yang valid. Keluarga alamat yang ditentukan dalam Anggota sumber dalam struktur MIB_IPPATH_ROW juga harus cocok dengan keluarga alamat IP tujuan yang ditentukan di anggota Tujuan atau keluarga alamat di anggota Sumber harus ditentukan sebagai AF_UNSPEC. Selain itu, setidaknya salah satu anggota berikut dalam struktur MIB_IPPATH_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 diatur untuk anggota InterfaceLuid (nilai anggota ini diatur ke nol), maka anggota InterfaceIndex berikutnya digunakan untuk menentukan antarmuka.

Pada output ketika panggilan berhasil, GetIpPathEntry mengambil properti lain untuk entri jalur IP dan mengisi struktur MIB_IPPATH_ROW yang ditunjukkan oleh parameter Baris .

Fungsi GetIpPathTable dapat dipanggil untuk menghitung entri jalur 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

Lihat juga

Bagikan melalui