Fungsi SetIpStatisticsEx (iphlpapi.h)

Artikel
08/24/2023

Fungsi SetIpStatisticsEx mengaktifkan atau menonaktifkan penerusan IP dan mengatur nilai time-to-live (TTL) default untuk komputer lokal.

Sintaks

IPHLPAPI_DLL_LINKAGE ULONG SetIpStatisticsEx(
  [in] PMIB_IPSTATS Statistics,
       ULONG        Family
);

Parameter

[in] Statistics

Penunjuk ke struktur MIB_IPSTATS . Pemanggil harus mengatur anggota dwForwarding dan dwDefaultTTL dari struktur ini ke nilai baru. Untuk mempertahankan salah satu anggota pada nilainya saat ini, gunakan MIB_USE_CURRENT_TTL atau MIB_USE_CURRENT_FORWARDING.

Family

Keluarga alamat tempat penerusan dan TTL akan diatur.

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 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 AF_INET, dan AF_INET6.

Nilai	Makna
AF_INET 2	Keluarga alamat Protokol Internet versi 4 (IPv4). Ketika parameter ini ditentukan, fungsi ini mengatur opsi penerusan dan TTL untuk entri IPv4.
AF_INET6 23	Keluarga alamat Protokol Internet versi 6 (IPv6). Ketika parameter ini ditentukan, fungsi ini mengatur opsi penerusan dan TTL untuk entri IPv6.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan 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 penunjuk NULL diteruskan dalam parameter pIpStats atau parameter Family tidak diatur ke AF_INET, dan AF_INET6. Kesalahan ini juga dikembalikan jika anggota dwForwarding dalam struktur MIB_IPSTATS yang ditunjukkan oleh parameter pIpStats berisi nilai selain MIB_IP_NOT_FORWARDING, MIB_IP_FORWARDING, atau MIB_USE_CURRENT_FORWARDING.
ERROR_NOT_SUPPORTED	Permintaan tidak didukung. Kesalahan ini dikembalikan jika tidak ada tumpukan IPv4 di komputer lokal dan AF_INET ditentukan dalam parameter Keluarga atau tidak ada tumpukan IPv6 di komputer lokal dan AF_INET6 ditentukan dalam anggota Keluarga .
Lainnya	Gunakan FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan.

Keterangan

Untuk mengatur hanya TTL default, pemanggil juga dapat menggunakan fungsi SetIpTTL .

Fungsi SetIpStatisticsEx hanya dapat dipanggil oleh pengguna yang masuk sebagai anggota grup Administrator. Jika SetIpStatisticsEx dipanggil oleh pengguna yang bukan anggota grup Administrator, panggilan fungsi akan gagal dan ERROR_ACCESS_DENIED dikembalikan.

Fungsi SetIpStatisticsEx 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 diatur ke requireAdministrator. Jika aplikasi pada 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


Klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	iphlpapi.h
Pustaka	Iphlpapi.lib
DLL	Iphlpapi.dll