wlanapi.h (wlanReasonCodeToString 函数)

WlanReasonCodeToString 函数检索描述指定原因代码的字符串。

语法

DWORD WlanReasonCodeToString(
  [in] DWORD  dwReasonCode,
  [in] DWORD  dwBufferSize,
  [in] PWCHAR pStringBuffer,
       PVOID  pReserved
);

参数

[in] dwReasonCode

请求字符串说明的 WLAN_REASON_CODE 值。

[in] dwBufferSize

用于在 WCHAR 中存储字符串的缓冲区的大小。 如果原因代码字符串长于缓冲区,则会将其截断并终止为 NULL。 如果 dwBufferSize 大于分配给 pStringBuffer 的实际内存量,则调用程序中将发生访问冲突。

[in] pStringBuffer

指向将接收字符串的缓冲区的指针。 调用方必须在调用 WlanReasonCodeToString 之前将内存分配给 pStringBuffer

pReserved

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

返回值

如果函数成功,则返回值是指向常量字符串的指针。

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

返回代码 说明
ERROR_INVALID_PARAMETER
参数不正确。 如果出现以下任一情况,则返回此错误:
  • dwBufferSize 为 0。
  • pStringBufferNULL
  • pReserved 不为 NULL
其他
各种 RPC 和其他错误代码。 使用 FormatMessage 获取返回错误的消息字符串。

要求

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

另请参阅

WLAN_REASON_CODE