Fungsi WlanSetProfileEapXmlUserData (wlanapi.h)

Artikel
08/28/2023

Fungsi WlanSetProfileEapXmlUserData mengatur kredensial pengguna Extensible Authentication Protocol (EAP) seperti yang ditentukan oleh string XML. Kredensial pengguna berlaku untuk profil pada adaptor. Kredensial ini hanya dapat digunakan oleh pemanggil.

Sintaks

DWORD WlanSetProfileEapXmlUserData(
  [in] HANDLE     hClientHandle,
  [in] const GUID *pInterfaceGuid,
  [in] LPCWSTR    strProfileName,
  [in] DWORD      dwFlags,
  [in] LPCWSTR    strEapXmlUserData,
       PVOID      pReserved
);

Parameter

[in] hClientHandle

Handel sesi klien, diperoleh dari 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.

Windows XP dengan SP3 dan Wireless LAN API untuk Windows XP dengan SP2: Nama yang disediakan harus cocok dengan nama profil yang berasal secara otomatis dari SSID jaringan. Untuk profil jaringan infrastruktur, SSID harus disediakan untuk nama profil. Untuk profil jaringan ad hoc, nama yang disediakan harus SSID dari jaringan ad hoc diikuti oleh -adhoc.

[in] dwFlags

Sekumpulan bendera yang memodifikasi perilaku fungsi.

Pada WIRELESS LAN API untuk Windows XP dengan SP2, Windows XP dengan SP3, 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] strEapXmlUserData

Penunjuk ke data XML yang digunakan untuk mengatur kredensial pengguna.

Data XML harus didasarkan pada skema Kredensial Pengguna EAPHost. Untuk melihat contoh data XML kredensial pengguna, lihat Properti Pengguna EAPHost.

pReserved

Disiapkan untuk penggunaan masa mendatang. Harus diatur ke NULL.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan adalah ERROR_SUCCESS.

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

Menampilkan kode	Deskripsi
ERROR_ACCESS_DENIED	Akses ditolak. Nilai ini dikembalikan jika penelepon tidak memiliki akses tulis ke profil.
ERROR_BAD_PROFILE	Profil koneksi jaringan rusak. Kesalahan ini dikembalikan jika profil yang ditentukan dalam parameter strProfileName tidak dapat diurai.
ERROR_INVALID_PARAMETER	Parameter salah. Nilai ini dikembalikan jika salah satu kondisi berikut terjadi: hClientHandle adalah NULL. pInterfaceGuid adalah NULL. strProfileName adalah NULL. strEapXmlUserData adalah NULL. pReserved bukan NULL.
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. Pada Windows 7, Windows Server 2008 R2 , dan yang lebih baru, nilai ini dikembalikan jika fungsi WlanSetProfileEapXmlUserData dipanggil pada profil yang menggunakan metode selain 802.1X untuk autentikasi.
ERROR_SERVICE_NOT_ACTIVE	Layanan belum dimulai. Nilai ini dikembalikan jika layanan LAN Nirkabel tidak berjalan.
RPC_STATUS	Berbagai kode kesalahan.

Keterangan

Fungsi WlanSetProfileEapXmlUserData mengatur kredensial pengguna EAP untuk digunakan pada profil. Fungsi ini hanya dapat dipanggil pada profil yang menggunakan 802.1X untuk autentikasi. 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 dari RFC 3748 yang diterbitkan oleh IETF.

Pada Windows 10, Windows Server 2016, dan yang lebih baru, fungsi WlanSetProfileEapXmlUserData ditingkatkan. Kredensial pengguna EAP dapat diatur untuk semua pengguna profil jika parameter dwFlags berisi WLAN_SET_EAPHOST_DATA_ALL_USERS.

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 WlanSetProfileEapXmlUserData 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).

WlanSetProfileEapXmlUserData dapat menyebabkan kegagalan koneksi nirkabel saat Anda menggunakan EAP-TTLS dan API dipanggil dari aplikasi 32-bit yang berjalan pada sistem operasi (OS) 64-bit. Aplikasi Anda harus dibangun untuk arsitektur CPU yang sama dengan OS target.

Windows XP dengan SP3 dan Wireless LAN API untuk Windows XP dengan SP2: Fungsi ini hanya dapat digunakan untuk kredensial Protected EAP (PEAP). Ini tidak dapat digunakan untuk jenis EAP lainnya.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows Vista, Windows XP dengan SP3 [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
Redistribusi	API LAN Nirkabel untuk Windows XP dengan SP2