Fungsi GetIpNetTable2
Fungsi GetIpNetTable2 mengambil tabel tetangga IP di komputer lokal.
Sintaksis
NETIOAPI_API GetIpNetTable2(
_In_ ADDRESS_FAMILY Family,
_Out_ PMIB_IPNET_TABLE2 *Table
);
Parameter
Family [in]
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 Anda dapat menggunakan konstanta.
Pada Windows Vista dan versi sistem operasi Windows yang lebih baru, nilai yang mungkin untuk parameter Keluarga didefinisikan dalam file header Ws2def.h. Perhatikan bahwa file header Ws2def.h secara otomatis disertakan dalam Netioapi.h dan Anda tidak boleh menggunakan Ws2def.h secara langsung.
Nilai berikut saat ini didukung untuk keluarga alamat:
AF_INET
Keluarga alamat IPv4. Ketika nilai ini ditentukan, fungsi ini mengembalikan tabel alamat IP tetangga yang hanya berisi entri IPv4.AF_INET6
Keluarga alamat IPv6. Ketika nilai ini ditentukan, fungsi ini mengembalikan tabel alamat IP tetangga yang hanya berisi entri IPv6.AF_UNSPEC
Keluarga alamat tidak ditentukan. Ketika nilai ini ditentukan, fungsi ini mengembalikan tabel alamat IP tetangga yang berisi entri IPv4 dan IPv6.
Tabel [out]
Penunjuk ke struktur MIB_IPNET_TABLE2 yang berisi tabel entri alamat IP tetangga di komputer lokal.
Mengembalikan nilai
GetIpNetTable2 mengembalikan STATUS_SUCCESS jika fungsi berhasil.
Jika fungsi gagal, GetIpNetTable2 mengembalikan salah satu kode kesalahan berikut:
| Mengembalikan kode | Deskripsi |
|---|---|
| STATUS_INVALID_PARAMETER | Parameter yang tidak valid diteruskan ke fungsi. Kesalahan ini dikembalikan jika penunjuk NULL diteruskan dalam parameter Tabel atau parameter Keluarga tidak ditentukan sebagai AF_INET, AF_INET6, atau AF_UNSPEC. |
| STATUS_NOT_ENOUGH_MEMORY | Sumber daya memori tidak cukup tersedia untuk menyelesaikan operasi. |
| STATUS_NOT_FOUND | Tidak ada entri alamat IP tetangga, seperti yang ditentukan dalam parameter Keluarga, yang ditemukan. |
| STATUS_NOT_SUPPORTED | Permintaan tidak didukung. Kesalahan ini dikembalikan jika tidak ada tumpukan IPv4 yang terletak di komputer lokal dan AF_INET ditentukan dalam parameter Keluarga, atau jika tidak ada tumpukan IPv6 yang terletak di komputer lokal dan AF_INET6 ditentukan dalam parameter Family. Kesalahan ini juga dikembalikan pada versi Windows di mana fungsi ini tidak didukung. |
| Lainnya | Gunakan fungsi FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan. |
Komentar
Fungsi GetIpNetTable2 menghitung alamat IP tetangga di komputer lokal dan mengembalikan informasi ini dalam struktur MIB_IPNET_TABLE2.
GetIpNetTable2 mengembalikan entri alamat IP tetangga dalam struktur MIB_IPNET_TABLE2 dalam buffer yang ditunjuk parameter Tabel. Struktur MIB_IPNET_TABLE2 berisi jumlah entri alamat IP tetangga dan array struktur MIB_IPNET_ROW2 untuk setiap entri alamat IP tetangga. Ketika struktur yang dikembalikan ini tidak lagi diperlukan, driver Anda harus membebaskan memori dengan memanggil FreeMibTable.
Driver Anda harus menginisialisasi parameter Keluarga ke AF_INET, AF_INET6, atau AF_UNSPEC.
Perhatikan bahwa struktur MIB_IPNET_TABLE2 yang dikembalikan yang ditunjukkan parameter Tabel mungkin berisi padding untuk perataan antara anggota NumEntries dan entri array MIB_IPNET_ROW2 pertama dalam Tabel anggota struktur MIB_IPNET_TABLE2. Padding untuk perataan mungkin juga ada di antara entri array MIB_IPNET_ROW2. Akses apa pun ke entri array MIB_IPNET_ROW2 harus mengasumsikan padding mungkin ada.
Persyaratan
Platform target |
Universal |
Versi |
Tersedia di Windows Vista dan versi sistem operasi Windows yang lebih baru. |
Header |
Netioapi.h (termasuk Netioapi.h) |
Perpustakaan |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |