WlanSetProfileCustomUserData 函式 (wlanapi.h)

發行項
03/04/2024

WlanSetProfileCustomUserData 函式會設定與配置文件相關聯的自定義用戶數據。

語法

DWORD WlanSetProfileCustomUserData(
  [in] HANDLE      hClientHandle,
  [in] const GUID  *pInterfaceGuid,
  [in] LPCWSTR     strProfileName,
  [in] DWORD       dwDataSize,
  [in] const PBYTE pData,
       PVOID       pReserved
);

參數

[in] hClientHandle

用戶端的會話句柄，由先前呼叫 WlanOpenHandle 函式取得。

[in] pInterfaceGuid

介面的 GUID。

[in] strProfileName

與自訂用戶數據相關聯的配置檔名稱。配置檔名稱會區分大小寫。此字串必須以 NULL 結束。

[in] dwDataSize

pData 的大小，以位元組為單位。

[in] pData

要設定之用戶數據的指標。

pReserved

保留供未來使用。必須設定為 NULL。

傳回值

如果函式成功，傳回值會ERROR_SUCCESS。

如果函式失敗，傳回值可能是下列其中一個傳回碼。

傳回碼	Description
ERROR_INVALID_PARAMETER	發生下列其中一個條件： hClientHandle 為 NULL 或無效。 pInterfaceGuid 為 NULL。 strProfileName 為 NULL。 pReserved 不是 NULL。 dwDataSize 不是 0，pData 是 NULL。
ERROR_INVALID_HANDLE	句柄數據表中找不到句柄 hClientHandle 。
ERROR_NOT_SUPPORTED	從不支援的平臺呼叫此函式。如果使用SP2用戶端從具有SP3的Windows XP或適用於Windows XP的無線LAN API 呼叫此函式，將會傳回此值。
RPC_STATUS	各種錯誤碼。

備註

針對 Native Wifi AutoConfig 服務所使用的每個無線 WLAN 配置檔，Windows 會維護自定義用戶數據的概念。這個自定義用戶數據一開始不存在，但可以藉由呼叫 WlanSetProfileCustomUserData 函式來設定。每當呼叫 WlanSetProfile 函式修改配置檔時，自定義用戶數據就會重設為空白。

設定自定義用戶數據之後，可以使用 WlanGetProfileCustomUserData 函式來存取此數據。

執行設定文件作業時，所有無線 LAN 函式都需要無線介面的介面 GUID。拿掉無線介面時，其狀態會從無線 LAN 服務 (WLANSVC) 清除，而且無法執行任何配置檔作業。

如果 pInterfaceGuid 參數中指定的無線介面已從系統移除 ERROR_INVALID_PARAMETER ( 已移除的 USB 無線適配卡，WlanSetProfileCustomUserData 函式可能會失敗，例如) 。

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2008 [僅限傳統型應用程式]
目標平台	Windows
標頭	wlanapi.h (包含 Wlanapi.h)
程式庫	Wlanapi.lib
Dll	Wlanapi.dll