Função WlanReasonCodeToString (wlanapi.h)

Artigo
03/13/2024

A função WlanReasonCodeToString recupera uma cadeia de caracteres que descreve um código de motivo especificado.

Sintaxe

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

Parâmetros

[in] dwReasonCode

Um valor WLAN_REASON_CODE do qual a descrição da cadeia de caracteres é solicitada.

[in] dwBufferSize

O tamanho do buffer usado para armazenar a cadeia de caracteres, no WCHAR. Se a cadeia de caracteres de código do motivo for maior que o buffer, ela será truncada e terminada em NULL. Se dwBufferSize for maior que a quantidade real de memória alocada para pStringBuffer, uma violação de acesso ocorrerá no programa de chamada.

[in] pStringBuffer

Ponteiro para um buffer que receberá a cadeia de caracteres. O chamador deve alocar memória para pStringBuffer antes de chamar WlanReasonCodeToString.

pReserved

Reservado para uso futuro. Deve ser definido como NULL.

Retornar valor

Se a função for bem-sucedida, o valor retornado será um ponteiro para uma cadeia de caracteres constante.

Se a função falhar, o valor retornado poderá ser um dos seguintes códigos de retorno.

Código de retorno	Descrição
ERROR_INVALID_PARAMETER	Um parâmetro está incorreto. Esse erro será retornado se alguma das seguintes condições ocorrer: dwBufferSize é 0. pStringBuffer é NULL. pReserved não é NULL.
Outros	Vários RPC e outros códigos de erro. Use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista, Windows XP com SP3 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	wlanapi.h (inclua Wlanapi.h)
Biblioteca	Wlanapi.lib
DLL	Wlanapi.dll
Redistribuível	API de LAN sem fio para Windows XP com SP2

Confira também

WLAN_REASON_CODE

Compartilhar via