Fungsi WlanSetProfileCustomUserData (wlanapi.h)

Artikel
08/28/2023

Fungsi WlanSetProfileCustomUserData mengatur data pengguna kustom yang terkait dengan profil.

Sintaks

DWORD WlanSetProfileCustomUserData(
  [in] HANDLE      hClientHandle,
  [in] const GUID  *pInterfaceGuid,
  [in] LPCWSTR     strProfileName,
  [in] DWORD       dwDataSize,
  [in] const PBYTE pData,
       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 kustom. Nama profil peka huruf besar/kecil. String ini harus dihentikan NULL.

[in] dwDataSize

Ukuran pData, dalam byte.

[in] pData

Penunjuk ke data pengguna yang akan diatur.

pReserved

Disiapkan untuk penggunaan masa mendatang. Harus diatur ke NULL.

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan ERROR_SUCCESS.

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

Menampilkan kode	Deskripsi
ERROR_INVALID_PARAMETER	Salah satu kondisi berikut terjadi: hClientHandlenull atau tidak valid. pInterfaceGuid adalah NULL. strProfileName adalah NULL. pReserved bukan NULL. dwDataSize bukan 0 dan pData adalah NULL.
ERROR_INVALID_HANDLE	Handel hClientHandle tidak ditemukan dalam tabel handel.
ERROR_NOT_SUPPORTED	Fungsi ini dipanggil dari platform yang tidak didukung. Nilai ini akan dikembalikan jika fungsi ini dipanggil dari Windows XP dengan SP3 atau WIRELESS LAN API untuk Windows XP dengan klien SP2.
RPC_STATUS	Berbagai kode kesalahan.

Keterangan

Untuk setiap profil WLAN nirkabel yang digunakan oleh layanan AutoConfig Wifi Asli, Windows mempertahankan konsep data pengguna kustom. Data pengguna kustom ini awalnya tidak ada, tetapi dapat diatur dengan memanggil fungsi WlanSetProfileCustomUserData . Data pengguna kustom diatur ulang menjadi kosong setiap kali profil dimodifikasi dengan memanggil fungsi WlanSetProfile .

Setelah data pengguna kustom diatur, data ini dapat diakses menggunakan fungsi WlanGetProfileCustomUserData .

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 WlanSetProfileCustomUserData 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