Fonction WlanReasonCodeToString (wlanapi.h)

  • Article

La fonction WlanReasonCodeToString récupère une chaîne qui décrit un code de raison spécifié.

Syntaxe

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

Paramètres

[in] dwReasonCode

Valeur WLAN_REASON_CODE dont la description de chaîne est demandée.

[in] dwBufferSize

Taille de la mémoire tampon utilisée pour stocker la chaîne, dans WCHAR. Si la chaîne de code est plus longue que la mémoire tampon, elle est tronquée et terminée par NULL. Si dwBufferSize est supérieur à la quantité réelle de mémoire allouée à pStringBuffer, une violation d’accès se produit dans le programme appelant.

[in] pStringBuffer

Pointeur vers une mémoire tampon qui recevra la chaîne. L’appelant doit allouer de la mémoire à pStringBuffer avant d’appeler WlanReasonCodeToString.

pReserved

Réservé pour un usage futur. Doit être défini sur NULL.

Valeur retournée

Si la fonction réussit, la valeur de retour est un pointeur vers une chaîne constante.

Si la fonction échoue, la valeur de retour peut être l’un des codes de retour suivants.

Code de retour Description
ERROR_INVALID_PARAMETER
 Un paramètre est incorrect. Cette erreur est retournée si l’une des conditions suivantes se produit :
  • dwBufferSize a la valeur 0.
  • pStringBuffer a la valeur NULL.
  • pReserved n’est pas NULL.
Autres
 Divers codes d’erreur RPC et autres. Utilisez FormatMessage pour obtenir la chaîne de message de l’erreur retournée.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows Vista, Windows XP avec SP3 [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 [applications de bureau uniquement]
Plateforme cible Windows
En-tête wlanapi.h (incluez Wlanapi.h)
Bibliothèque Wlanapi.lib
DLL Wlanapi.dll
Composant redistribuable API LAN sans fil pour Windows XP avec SP2

Voir aussi

WLAN_REASON_CODE