Fungsi SetIfEntry (iphlpapi.h)

Artikel
08/24/2023

Fungsi SetIfEntry menetapkan status administratif antarmuka.

Sintaks

IPHLPAPI_DLL_LINKAGE DWORD SetIfEntry(
  [in] PMIB_IFROW pIfRow
);

Parameter

[in] pIfRow

Penunjuk ke struktur MIB_IFROW . Anggota dwIndex dari struktur ini menentukan antarmuka untuk mengatur status administratif. Anggota dwAdminStatus menentukan status administratif baru. Anggota dwAdminStatus bisa menjadi salah satu nilai berikut.

Nilai	Makna
MIB_IF_ADMIN_STATUS_UP	Antarmuka diaktifkan secara administratif.
MIB_IF_ADMIN_STATUS_DOWN	Antarmuka dinonaktifkan secara administratif.

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
ERROR_ACCESS_DENIED	Akses ditolak. Kesalahan ini dikembalikan pada Windows Vista dan kemudian 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_FILE_NOT_FOUND	Sistem tidak dapat menemukan file yang ditentukan. Kesalahan ini dikembalikan pada Windows Vista dan kemudian jika antarmuka jaringan yang ditentukan oleh anggota dwIndex dari struktur MIB_IFROW yang diarahkan oleh parameter pIfRow tidak dapat ditemukan.
ERROR_INVALID_PARAMETER	Parameter yang tidak valid diteruskan ke fungsi. Kesalahan ini dikembalikan jika penunjuk NULL diteruskan dalam parameter pIfRow , atau anggota dwIndex dari MIB_IFROW yang diarahkan oleh parameter pIfRow tidak ditentukan. Kesalahan ini juga dikembalikan pada Windows Server 2003 dan sebelumnya jika antarmuka jaringan yang ditentukan oleh anggota dwIndex dari struktur MIB_IFROW yang diarahkan oleh parameter pIfRow tidak dapat ditemukan.
ERROR_NOT_SUPPORTED	Permintaan tidak didukung. Kesalahan ini dikembalikan pada Windows Server 2003 dan sebelumnya jika tidak ada tumpukan TCP/IP yang dikonfigurasi pada komputer lokal.
Lainnya	Gunakan FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan.

Keterangan

Fungsi SetIfEntry digunakan untuk mengatur status administratif antarmuka di komputer lokal.

Anggota dwIndex dalam struktur MIB_IFROW yang diarahkan oleh parameter pIfRow harus diinisialisasi ke indeks antarmuka.

Fungsi SetIfEntry akan gagal jika anggota dwIndex dari MIB_IFROW yang diarahkan oleh parameter pIfRow tidak cocok dengan antarmuka yang ada di komputer lokal.

Pada Windows Vista dan yang lebih baru, fungsi SetIfEntry hanya dapat dipanggil oleh pengguna yang masuk sebagai anggota grup Administrator. Jika SetIfEntry dipanggil oleh pengguna yang bukan anggota grup Administrator, panggilan fungsi akan gagal dan ERROR_ACCESS_DENIED dikembalikan.

Fungsi SetIfEntry 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.

Catatan Pada Windows NT 4.0 dan Windows 2000 dan yang lebih baru, fungsi ini menjalankan operasi istimewa. Agar fungsi ini berhasil dijalankan, pemanggil harus masuk sebagai anggota grup Administrator atau grup NetworkConfigurationOperators.

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