Fungsi WlanSetProfileEapUserData (wlanapi.h)

Artikel
03/15/2023

Fungsi WlanSetProfileEapUserData menetapkan kredensial pengguna Extensible Authentication Protocol (EAP) seperti yang ditentukan oleh data EAP mentah. Kredensial pengguna berlaku untuk profil pada antarmuka.

Sintaks

DWORD WlanSetProfileEapUserData(
  [in] HANDLE          hClientHandle,
  [in] const GUID      *pInterfaceGuid,
  [in] LPCWSTR         strProfileName,
  [in] EAP_METHOD_TYPE eapType,
  [in] DWORD           dwFlags,
  [in] DWORD           dwEapUserDataSize,
  [in] const LPBYTE    pbEapUserData,
       PVOID           pReserved
);

Parameter

[in] hClientHandle

Handel sesi klien, diperoleh dengan panggilan sebelumnya ke fungsi WlanOpenHandle .

[in] pInterfaceGuid

GUID antarmuka.

[in] strProfileName

Nama profil yang terkait dengan data pengguna EAP. Nama profil peka huruf besar/kecil. String ini harus dihentikan NULL.

[in] eapType

Struktur EAP_METHOD_TYPE yang berisi metode di mana pemanggil menyediakan kredensial pengguna EAP.

[in] dwFlags

Sekumpulan bendera yang memodifikasi perilaku fungsi.

Pada Windows Vista dan Windows Server 2008, parameter ini dicadangkan dan harus diatur ke nol.

Pada Windows 7, Windows Server 2008 R2, dan yang lebih baru, parameter ini bisa menjadi salah satu nilai berikut.

Nilai	Makna
WLAN_SET_EAPHOST_DATA_ALL_USERS 0x00000001	Atur data host EAP untuk semua pengguna profil ini.

[in] dwEapUserDataSize

Ukuran, dalam byte, dari data yang ditunjukkan oleh pbEapUserData.

[in] pbEapUserData

Penunjuk ke data EAP mentah yang digunakan untuk mengatur kredensial pengguna.

Pada Windows Vista dan Windows Server 2008, parameter ini tidak boleh NULL.

Pada Windows 7, Windows Server 2008 R2, dan yang lebih baru, parameter ini dapat diatur ke NULL untuk menghapus kredensial yang disimpan untuk profil ini jika parameter dwFlags berisi WLAN_SET_EAPHOST_DATA_ALL_USERS dan parameter dwEapUserDataSize adalah 0.

pReserved

Disiapkan untuk penggunaan masa mendatang. Harus diatur ke NULL.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan ERROR_SUCCESS.

Jika fungsi gagal, nilai yang dikembalikan mungkin salah satu kode pengembalian berikut.

Menampilkan kode	Deskripsi
ERROR_ACCESS_DENIED	Akses ditolak. Nilai ini dikembalikan jika pemanggil tidak memiliki akses tulis ke profil.
ERROR_INVALID_PARAMETER	Parameter salah. Nilai ini dikembalikan jika salah satu kondisi berikut terjadi: hClientHandle adalah NULL. pInterfaceGuid adalah NULL. strProfileName adalah NULL pvReserved bukan NULL. Pada Windows Vista dan Windows Server 2008, nilai ini dikembalikan jika parameter pbEapUserData adalah NULL. Pada Windows 7, Windows Server 2008 R2 , dan yang lebih baru, kesalahan ini dikembalikan jika parameter pbEapUserData adalah NULL, tetapi parameter dwEapUserDataSize bukan 0 atau parameter dwFlags tidak berisi WLAN_SET_EAPHOST_DATA_ALL_USERS.
ERROR_INVALID_HANDLE	Handel tidak valid. Kesalahan ini dikembalikan jika handel hClientHandle tidak ditemukan dalam tabel handel.
ERROR_NOT_ENOUGH_MEMORY	Penyimpanan tidak cukup tersedia untuk memproses perintah ini.
ERROR_NOT_SUPPORTED	Permintaan tidak didukung. Nilai ini dikembalikan ketika pengaturan profil tidak mengizinkan penyimpanan data pengguna. Ini dapat terjadi ketika akses menyeluruh (SSO) diaktifkan atau ketika permintaannya adalah menghapus kredensial yang disimpan untuk profil ini (parameter pbEapUserData adalah NULL, parameter dwFlags berisi WLAN_SET_EAPHOST_DATA_ALL_USERS, dan parameter dwEapUserDataSize adalah 0). Pada Windows 10, Windows Server 2016 , dan yang lebih baru, nilai ini dikembalikan jika fungsi WlanSetProfileEapUserData dipanggil pada profil yang menggunakan metode selain 802.1X untuk autentikasi. Nilai ini juga dikembalikan jika fungsi ini dipanggil dari Windows XP dengan SP3 atau Wireless LAN API untuk Windows XP dengan klien SP2.
ERROR_SERVICE_NOT_ACTIVE	Layanan belum dimulai. Nilai ini dikembalikan jika layanan LAN Nirkabel tidak berjalan.
RPC_STATUS	Berbagai kode kesalahan.

Keterangan

Fungsi WlanSetProfileEapUserData mengatur kredensial pengguna EAP untuk digunakan pada profil. Pada Windows Vista dan Windows Server 2008, kredensial ini hanya dapat digunakan oleh pemanggil.

Parameter eapType adalah struktur EAP_METHOD_TYPE yang berisi jenis, identifikasi, dan informasi penulis tentang metode EAP. Anggota eapType dari struktur EAP_METHOD_TYPE adalah struktur EAP_TYPE yang berisi informasi identifikasi jenis dan vendor untuk metode EAP.

Untuk informasi selengkapnya tentang alokasi jenis metode EAP, lihat bagian 6.2 RFC 3748 yang diterbitkan oleh IETF.

Pada Windows 7, Windows Server 2008 R2, dan yang lebih baru, fungsi WlanSetProfileEapUserData ditingkatkan. Kredensial pengguna EAP dapat diatur untuk semua pengguna profil jika parameter dwFlags berisi WLAN_SET_EAPHOST_DATA_ALL_USERS. Kredensial pengguna EAP di profil juga dapat dihapus. Untuk menghapus kredensial pengguna EAP pada profil, parameter pbEapUserData harus NULL, parameter dwFlags harus sama dengan WLAN_SET_EAPHOST_DATA_ALL_USERS, dan parameter dwEapUserDataSize harus 0.

Semua fungsi LAN nirkabel memerlukan GUID antarmuka untuk antarmuka nirkabel saat melakukan operasi profil. Ketika antarmuka nirkabel dihapus, statusnya dibersihkan dari Layanan LAN Nirkabel (WLANSVC) dan tidak ada operasi profil yang dimungkinkan.

Fungsi WlanSetProfileEapUserData dapat gagal dengan ERROR_INVALID_PARAMETER jika antarmuka nirkabel yang ditentukan dalam parameter pInterfaceGuid telah dihapus dari sistem (adaptor nirkabel USB yang telah dihapus, misalnya).

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	wlanapi.h (termasuk Wlanapi.h)
Pustaka	Wlanapi.lib
DLL	Wlanapi.dll