Функция WlanReasonCodeToString (wlanapi.h)

Статья
08/28/2023

Функция 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.

Возвращаемое значение

Если функция выполняется успешно, возвращаемое значение является указателем на константную строку.

Если функция завершается сбоем, возвращаемое значение может быть одним из следующих кодов возврата.

Код возврата	Описание
ERROR_INVALID_PARAMETER	Неправильный параметр. Эта ошибка возвращается при возникновении какого-либо из следующих условий: значение dwBufferSize равно 0. pStringBuffer имеет значение NULL. pReserved не имеет значение NULL.
Другое	Различные коды RPC и другие коды ошибок. Используйте FormatMessage , чтобы получить строку сообщения для возвращаемой ошибки.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista, Windows XP с пакетом обновления 3 (SP3) [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	wlanapi.h (включая Wlanapi.h)
Библиотека	Wlanapi.lib
DLL	Wlanapi.dll
Распространяемые компоненты	API беспроводной локальной сети для Windows XP с пакетом обновления 2 (SP2)

См. также раздел

WLAN_REASON_CODE

Поделиться через