WlanReasonCodeToString 函式 (wlanapi.h)

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

將接收字串之緩衝區的指標。呼叫端必須先配置記憶體給 pStringBuffer ，才能呼叫 WlanReasonCodeToString。

pReserved

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

如果函式成功，則傳回值是常數位符串的指標。

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

傳回碼	Description
ERROR_INVALID_PARAMETER	參數不正確。如果發生下列任一狀況，就會傳回此錯誤： dwBufferSize 為 0。 pStringBuffer 為 NULL。 pReserved 不是 NULL。
其他	各種 RPC 和其他錯誤碼。使用 FormatMessage 取得傳回錯誤的訊息字串。

需求	值
最低支援的用戶端	Windows Vista、Windows XP SP3 [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2008 [僅限傳統型應用程式]
目標平台	Windows
標頭	wlanapi.h (包含 Wlanapi.h)
程式庫	Wlanapi.lib
Dll	Wlanapi.dll
可轉散發套件	Windows XP 搭配 SP2 的無線 LAN API