WlanDisconnect 函数 (wlanapi.h)

  • 项目

WlanDisconnect 函数断开接口与其当前网络的连接。

语法

DWORD WlanDisconnect(
  [in] HANDLE     hClientHandle,
  [in] const GUID *pInterfaceGuid,
       PVOID      pReserved
);

参数

[in] hClientHandle

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

[in] pInterfaceGuid

要断开连接的接口的 GUID。

pReserved

保留供将来使用。 必须设置为 NULL。

返回值

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

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

返回代码 说明
ERROR_INVALID_PARAMETER
 hClientHandle 为 NULL 或无效， pInterfaceGuid 为 NULL，或 pReserved 不为 NULL。
ERROR_INVALID_HANDLE
 在句柄表中找不到句柄 hClientHandle 。
RPC_STATUS
 各种错误代码。
ERROR_NOT_ENOUGH_MEMORY
 未能为查询结果分配内存。
ERROR_ACCESS_DENIED
 调用方没有足够的权限。

注解

使用 WlanConnect 建立连接时，由 pConnectionParameters 指向的WLAN_CONNECTION_PARAMETERS结构的 strProfile 成员指定配置文件。 如果该配置文件是全用户配置文件， 则 WlanDisconnect 调用方必须对该配置文件具有执行访问权限。 否则， WlanDisconnect 调用将失败，返回值ERROR_ACCESS_DENIED。 在使用 WlanSetProfile 或 WlanSaveTemporaryProfile 创建或保存配置文件时，将建立对所有用户配置文件的权限。

若要在命令行上执行断开连接操作，请使用 netsh wlan disconnect 命令。 有关详细信息，请参阅 适用于无线局域网的 Netsh 命令 (wlan) 。

具有 SP3 的 Windows XP 和适用于 SP2 的 Windows XP 的无线 LAN API： WlanDisconnect 具有修改与断开连接的网络关联的配置文件的副作用。 在 WlanDisconnect 调用后，网络配置文件将成为按需配置文件。 当网络处于范围内时，无线零配置服务不会自动连接到具有按需配置文件的网络。 除非要将配置文件更改为按需配置文件，否则不要在调用 WlanConnect 之前调用 WlanDisconnect。 调用 WlanConnect 建立网络连接时，将自动断开任何现有网络连接。

要求

   
最低受支持的客户端 Windows Vista、Windows XP 和 SP3 [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 wlanapi.h (包括 Wlanapi.h)
Library Wlanapi.lib
DLL Wlanapi.dll
可再发行组件 适用于 Windows XP 的无线 LAN API SP2

另请参阅

WlanConnect