wlanHostedNetworkQueryProperty 函数 (wlanapi.h)

项目
08/28/2023

WlanHostedNetworkQueryProperty 函数查询无线托管网络的当前静态属性。

语法

DWORD WlanHostedNetworkQueryProperty(
  [in]  HANDLE                     hClientHandle,
  [in]  WLAN_HOSTED_NETWORK_OPCODE OpCode,
  [out] PDWORD                     pdwDataSize,
  [out] PVOID                      *ppvData,
  [out] PWLAN_OPCODE_VALUE_TYPE    pWlanOpcodeValueType,
        PVOID                      pvReserved
);

参数

[in] hClientHandle

客户端的会话句柄，由上一次对 WlanOpenHandle 函数的调用返回。

[in] OpCode

要查询的属性的标识符。此标识符可以是 wlanapi.h 头文件中定义的WLAN_HOSTED_NETWORK_OPCODE枚举中的任何值。

[out] pdwDataSize

指向一个值的指针，该值指定在对 WlanHostedNetworkQueryProperty 函数的调用成功时 ppvData 参数中返回的缓冲区的大小（以字节为单位）。

[out] ppvData

输入时，此参数必须为 NULL。

在输出时，如果对 WlanHostedNetworkQueryProperty 函数的调用成功，此参数将接收指向返回的缓冲区的指针，该缓冲区具有请求的静态属性。与此缓冲区关联的数据类型取决于 OpCode 参数的值。

[out] pWlanOpcodeValueType

指向接收无线托管网络属性的值类型的指针（如果对 WlanHostedNetworkQueryProperty 函数的调用成功）。返回的值是在 wlanapi.h 头文件中定义的WLAN_OPCODE_VALUE_TYPE枚举中的枚举类型。

pvReserved

保留供将来使用。此参数必须为 NULL。

返回值

如果函数成功，则返回值为 ERROR_SUCCESS。

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

返回代码	说明
ERROR_BAD_CONFIGURATION	无线托管网络的配置数据未配置。如果在无线托管网络中配置 SSID 之前，应用程序调用 OpCode 参数设置为 wlan_hosted_network_opcode_station_profile 或 wlan_hosted_network_opcode_connection_settings的 WlanHostedNetworkQueryProperty 函数，则返回此错误。
ERROR_INVALID_HANDLE	句柄无效。如果在句柄表中找不到 hClientHandle 参数中指定的句柄，则返回此错误。
ERROR_INVALID_PARAMETER	参数不正确。如果出现以下任一情况，将返回此错误： hClientHandle 为 NULL。 OpCode 不是 WLAN_HOSTED_NETWORK_OPCODE中定义的枚举值之一。 pdwDataSize 为 NULL。 ppvData 为 NULL。 pWlanOpcodeValueType 为 NULL。 pvReserved 不为 NULL。
ERROR_INVALID_STATE	资源未处于执行所请求操作的正确状态。如果无线托管网络正在关闭，则可能会发生这种情况。
ERROR_OUTOFMEMORY	没有足够的存储空间来完成此操作。
ERROR_SERVICE_NOT_ACTIVE	该服务尚未启动。如果 WLAN 自动配置服务未运行，则返回此错误。
其他	各种 RPC 和其他错误代码。使用 FormatMessage 获取返回错误的消息字符串。

注解

WlanHostedNetworkQueryProperty 函数是本机无线 API 的扩展，添加了支持安装了无线 LAN 服务的 Windows 7 和 Windows Server 2008 R2 上的无线托管网络。

客户端应用程序调用 WlanHostedNetworkQueryProperty 函数来查询无线托管网络的当前静态属性。此函数不会更改无线托管网络的状态或属性。

如果函数成功， ppvData 参数将指向包含所请求属性的缓冲区。此缓冲区的大小在 pwdDataSize 参数中返回的指针中返回。 WLAN_OPCODE_VALUE_TYPE在 pWlanOpcodeValueType 参数中返回的指针中返回。在不再需要缓冲区后，应通过调用 WlanFreeMemory 函数释放返回的 ppvData 参数中用于缓冲区的内存。

与 ppvData 参数指向的缓冲区关联的数据类型取决于 OpCode 参数的值，如下所示：

OpCode	说明
wlan_hosted_network_opcode_connection_settings	返回指向 WLAN_HOSTED_NETWORK_CONNECTION_SETTINGS 结构的指针。
wlan_hosted_network_opcode_security_settings	返回指向 WLAN_HOSTED_NETWORK_SECURITY_SETTINGS 结构的指针。
wlan_hosted_network_opcode_station_profile	返回一个 PWSTR ，其中包含用于连接到无线托管网络的 XML WLAN 配置文件。
wlan_hosted_network_opcode_enable	返回一个 PBOOL ，指示是否启用了无线托管网络。

如果在无线托管网络中配置 SSID 之前，在 OpCode 参数中传递了 WlanHostedNetworkQueryProperty 函数，则函数将失败并ERROR_BAD_CONFIGURATION：

wlan_hosted_network_opcode_station_profile
wlan_hosted_network_opcode_connection_settings

任何用户都可以调用 WlanHostedNetworkQueryProperty 函数来查询托管网络属性。

在 Windows 7 及更高版本上，如果计算机上存在支持托管网络的无线适配器，则操作系统将安装虚拟设备。如果计算机具有单个无线网络适配器，此虚拟设备通常显示在“网络Connections文件夹中”显示为“无线网络连接 2”，设备名称为“Microsoft 虚拟 WiFi 微型端口适配器”。此虚拟设备专门用于执行软接入点 (SoftAP) 连接，并且不存在于 WlanEnumInterfaces 函数返回的列表中。此虚拟设备的生存期与物理无线适配器相关联。如果物理无线适配器处于禁用状态，此虚拟设备也将被删除。此功能在安装了无线 LAN 服务的 Windows Server 2008 R2 上也可用。

要求

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