Fungsi GetIpForwardTable2 (netioapi.h)

Artikel
03/15/2023

Fungsi GetIpForwardTable2 mengambil entri rute IP di komputer lokal.

Sintaks

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpForwardTable2(
  [in]  ADDRESS_FAMILY        Family,
  [out] PMIB_IPFORWARD_TABLE2 *Table
);

Parameter

[in] Family

Keluarga alamat yang akan diambil.

Nilai yang mungkin untuk keluarga alamat tercantum dalam file header Winsock2.h . Perhatikan bahwa nilai untuk keluarga alamat AF_ dan konstanta keluarga protokol PF_ identik (misalnya, AF_INET dan PF_INET), sehingga konstanta mana pun dapat digunakan.

Pada Windows SDK yang dirilis untuk Windows Vista dan yang lebih baru, organisasi file header telah berubah dan nilai yang mungkin untuk anggota ini ditentukan dalam file header Ws2def.h . Perhatikan bahwa file header Ws2def.h secara otomatis disertakan dalam Winsock2.h, dan tidak boleh digunakan secara langsung.

Nilai yang saat ini didukung adalah AF_INET, AF_INET6, dan AF_UNSPEC.

Nilai	Makna
AF_UNSPEC 0	Keluarga alamat tidak ditentukan. Ketika parameter ini ditentukan, fungsi ini mengembalikan tabel perutean IP yang berisi entri IPv4 dan IPv6.
AF_INET 2	Keluarga alamat Protokol Internet versi 4 (IPv4). Ketika parameter ini ditentukan, fungsi ini mengembalikan tabel perutean IP yang hanya berisi entri IPv4.
AF_INET6 23	Keluarga alamat Protokol Internet versi 6 (IPv6). Ketika parameter ini ditentukan, fungsi ini mengembalikan tabel perutean IP yang hanya berisi entri IPv6.

[out] Table

Penunjuk ke struktur MIB_IPFORWARD_TABLE2 yang berisi tabel entri rute IP di komputer lokal.

Mengembalikan nilai

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_INVALID_PARAMETER	Parameter yang tidak valid diteruskan ke fungsi. Kesalahan ini dikembalikan jika penunjuk NULL diteruskan dalam parameter Tabel atau parameter Family tidak ditentukan sebagai AF_INET, AF_INET6, atau AF_UNSPEC.
ERROR_NOT_ENOUGH_MEMORY	Sumber daya memori tidak cukup tersedia untuk menyelesaikan operasi.
ERROR_NOT_FOUND	Tidak ada entri rute IP seperti yang ditentukan dalam parameter Keluarga yang ditemukan.
ERROR_NOT_SUPPORTED	Permintaan tidak didukung. Kesalahan ini dikembalikan jika tidak ada tumpukan IPv4 di komputer lokal dan AF_INET ditentukan dalam parameter Keluarga . Kesalahan ini juga dikembalikan jika tidak ada tumpukan IPv6 di komputer lokal dan AF_INET6 ditentukan dalam parameter Keluarga . Kesalahan ini juga dikembalikan pada versi Windows di mana fungsi ini tidak didukung.
Lainnya	Gunakan FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan.

Keterangan

Fungsi GetIpForwardTable2 didefinisikan pada Windows Vista dan yang lebih baru.

The
Fungsi GetIpForwardTable2 menghitung entri rute IP pada sistem lokal dan mengembalikan informasi ini dalam struktur MIB_IPFORWARD_TABLE2 .

Entri rute IP dikembalikan dalam struktur MIB_IPFORWARD_TABLE2 dalam buffer yang diarahkan oleh parameter Tabel . Struktur MIB_IPFORWARD_TABLE2 berisi jumlah entri rute IP dan array struktur MIB_IPFORWARD_ROW2 untuk setiap entri rute IP. Ketika struktur yang dikembalikan ini tidak lagi diperlukan, kosongkan memori dengan memanggil FreeMibTable.

Parameter Keluarga harus diinisialisasi ke AF_INET, AF_INET6, atau AF_UNSPEC.

Perhatikan bahwa struktur MIB_IPFORWARD_TABLE2 yang dikembalikan yang diarahkan oleh parameter Tabel mungkin berisi pengisi untuk perataan antara anggota NumEntries dan entri array MIB_IPFORWARD_ROW2 pertama di anggota Tabel dari struktur MIB_IPFORWARD_TABLE2 . Padding untuk perataan mungkin juga ada di antara entri array MIB_IPFORWARD_ROW2 . Setiap akses ke entri array MIB_IPFORWARD_ROW2 harus mengasumsikan padding mungkin ada.

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