Fungsi FlushIpNetTable2 (netioapi.h)

Artikel
08/25/2023

Fungsi FlushIpNetTable2 membersihkan tabel tetangga IP di komputer lokal.

Sintaks

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API FlushIpNetTable2(
  [in] ADDRESS_FAMILY Family,
  [in] NET_IFINDEX    InterfaceIndex
);

Parameter

[in] Family

Keluarga alamat untuk menyiram.

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 menghapus tabel alamat IP tetangga yang berisi entri IPv4 dan IPv6.
AF_INET 2	Keluarga alamat Protokol Internet versi 4 (IPv4). Ketika parameter ini ditentukan, fungsi ini menghapus tabel alamat IP tetangga yang hanya berisi entri IPv4.
AF_INET6 23	Keluarga alamat Protokol Internet versi 6 (IPv6). Ketika parameter ini ditentukan, fungsi ini menghapus tabel alamat IP tetangga yang hanya berisi entri IPv6.

[in] InterfaceIndex

Indeks antarmuka. Jika indeks ditentukan, hapus entri alamat IP tetangga pada antarmuka tertentu, jika tidak, hapus entri alamat IP tetangga pada semua antarmuka. Untuk mengabaikan antarmuka, atur parameter ini ke nol.

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_ACCESS_DENIED	Akses ditolak. Kesalahan ini dikembalikan dalam beberapa kondisi yang mencakup hal berikut: pengguna tidak memiliki hak istimewa administratif yang diperlukan di komputer lokal atau aplikasi tidak berjalan dalam shell yang ditingkatkan sebagai Administrator bawaan (administrator RunAs).
ERROR_INVALID_PARAMETER	Parameter yang tidak valid diteruskan ke fungsi. Kesalahan ini dikembalikan jika parameter Family tidak ditentukan sebagai AF_INET, AF_INET6, atau AF_UNSPEC.
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 FlushIpNetTable2 didefinisikan pada Windows Vista dan yang lebih baru.

The
Fungsi FlushIpNetTable2 menghapus atau menghapus alamat IP tetangga pada sistem lokal. Parameter Keluarga dapat digunakan untuk membatasi alamat IP tetangga untuk dihapus ke keluarga alamat IP tertentu. Jika alamat IP tetangga untuk IPv4 dan IPv6 harus dihapus, atur parameter Family ke AF_UNSPEC. Parameter InterfaceIndex dapat digunakan untuk membatasi alamat IP tetangga untuk dihapus ke antarmuka tertentu. Jika alamat IP tetangga untuk semua antarmuka harus dihapus, atur parameter InterfaceIndex ke nol.

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

Fungsi FlushIpNetTable2 hanya dapat dipanggil oleh pengguna yang masuk sebagai anggota grup Administrator. Jika FlushIpNetTable2 dipanggil oleh pengguna yang bukan anggota grup Administrator, panggilan fungsi akan gagal dan ERROR_ACCESS_DENIED dikembalikan. Fungsi ini juga dapat gagal karena kontrol akun pengguna (UAC) pada Windows Vista dan yang lebih baru. Jika aplikasi yang berisi fungsi ini dijalankan oleh pengguna yang masuk sebagai anggota grup Administrator selain Administrator bawaan, panggilan ini akan gagal kecuali aplikasi telah ditandai dalam file manifes dengan requestedExecutionLevel yang diatur ke requireAdministrator. Jika aplikasi tidak memiliki file manifes ini, pengguna yang masuk sebagai anggota grup Administrator selain Administrator bawaan kemudian harus menjalankan aplikasi dalam shell yang ditingkatkan sebagai Administrator bawaan (administrator RunAs) agar fungsi ini berhasil.

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