wlanSetProfileCustomUserData 函数 (wlanapi.h)

项目
08/28/2023

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。

如果函数失败，则返回值可能是以下返回代码之一。

返回代码	说明
ERROR_INVALID_PARAMETER	出现以下情况之一： hClientHandle 为 NULL 或无效。 pInterfaceGuid 为 NULL。 strProfileName 为 NULL。 pReserved 不为 NULL。 dwDataSize 不为 0，pData 为 NULL。
ERROR_INVALID_HANDLE	在句柄表中找不到句柄 hClientHandle 。
ERROR_NOT_SUPPORTED	此函数是从不受支持的平台调用的。如果从具有 SP3 的 Windows XP 或具有 SP2 客户端的 Windows XP 无线 LAN API 调用此函数，则将返回此值。
RPC_STATUS	各种错误代码。

注解

对于 Native Wifi AutoConfig 服务使用的每个无线 WLAN 配置文件，Windows 维护自定义用户数据的概念。此自定义用户数据最初不存在，但可以通过调用 WlanSetProfileCustomUserData 函数进行设置。每当通过调用 WlanSetProfile 函数修改配置文件时，自定义用户数据都会重置为空。

设置自定义用户数据后，可以使用 WlanGetProfileCustomUserData 函数访问此数据。

执行配置文件操作时，所有无线 LAN 函数都需要无线接口的接口 GUID。删除无线接口时，其状态将从无线 LAN 服务 (WLANSVC) 清除，并且无法执行配置文件操作。

如果 pInterfaceGuid 参数中指定的无线接口已从系统中删除， (已删除的 USB 无线适配器（例如 ) ），WlanSetProfileCustomUserData 函数可能会失败，并ERROR_INVALID_PARAMETER。

要求

要求	值
最低受支持的客户端	Windows Vista [仅限桌面应用]
最低受支持的服务器	Windows Server 2008 [仅限桌面应用]
目标平台	Windows
标头	wlanapi.h (包括 Wlanapi.h)
Library	Wlanapi.lib
DLL	Wlanapi.dll