Fungsi SetIpStatistics (iphlpapi.h)
Fungsi SetIpStatistics mengaktifkan atau menonaktifkan penerusan IP dan mengatur nilai time-to-live (TTL) default untuk komputer lokal.
Sintaks
IPHLPAPI_DLL_LINKAGE DWORD SetIpStatistics(
[in] PMIB_IPSTATS pIpStats
);
Parameter
[in] pIpStats
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.
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 |
|---|---|
|
Akses ditolak. Kesalahan ini dikembalikan pada Windows Vista dan Windows Server 2008 dalam beberapa kondisi yang mencakup hal berikut: pengguna tidak memiliki hak administratif yang diperlukan di komputer lokal atau aplikasi tidak berjalan dalam shell yang ditingkatkan sebagai Administrator bawaan (administrator RunAs). |
|
Parameter yang tidak valid diteruskan ke fungsi. Kesalahan ini dikembalikan jika penunjuk NULL diteruskan dalam parameter pIpStats . 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. |
|
Gunakan FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan. |
Keterangan
Untuk mengatur hanya TTL default, pemanggil juga dapat menggunakan fungsi SetIpTTL .
Pada Windows Vista dan yang lebih baru, fungsi SetIpStatistics hanya dapat dipanggil oleh pengguna yang masuk sebagai anggota grup Administrator. Jika SetIpStatistics dipanggil oleh pengguna yang bukan anggota grup Administrator, panggilan fungsi akan gagal dan ERROR_ACCESS_DENIED dikembalikan.
Fungsi SetIpStatistics 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
| Klien minimum yang didukung | Windows 2000 Professional [hanya aplikasi desktop] |
| Server minimum yang didukung | Windows 2000 Server [hanya aplikasi desktop] |
| Target Platform | Windows |
| Header | iphlpapi.h |
| Pustaka | Iphlpapi.lib |
| DLL | Iphlpapi.dll |