Fonction WlanHostedNetworkQueryProperty (wlanapi.h)

Article
08/28/2023

La fonction WlanHostedNetworkQueryProperty interroge les propriétés statiques actuelles du réseau hébergé sans fil.

Syntaxe

DWORD WlanHostedNetworkQueryProperty(
  [in]  HANDLE                     hClientHandle,
  [in]  WLAN_HOSTED_NETWORK_OPCODE OpCode,
  [out] PDWORD                     pdwDataSize,
  [out] PVOID                      *ppvData,
  [out] PWLAN_OPCODE_VALUE_TYPE    pWlanOpcodeValueType,
        PVOID                      pvReserved
);

Paramètres

[in] hClientHandle

Le handle de session du client, retourné par un appel précédent à la fonction WlanOpenHandle .

[in] OpCode

Identificateur de la propriété à interroger. Cet identificateur peut être l’une des valeurs de l’énumération WLAN_HOSTED_NETWORK_OPCODE définie dans le fichier d’en-tête Wlanapi.h .

[out] pdwDataSize

Pointeur vers une valeur qui spécifie la taille, en octets, de la mémoire tampon retournée dans le paramètre ppvData , si l’appel à la fonction WlanHostedNetworkQueryProperty réussit.

[out] ppvData

En entrée, ce paramètre doit avoir la valeur NULL.

À la sortie, ce paramètre reçoit un pointeur vers une mémoire tampon retournée avec la propriété statique demandée, si l’appel à la fonction WlanHostedNetworkQueryProperty réussit. Le type de données associé à cette mémoire tampon dépend de la valeur du paramètre OpCode .

[out] pWlanOpcodeValueType

Pointeur vers une valeur qui reçoit le type valeur de la propriété réseau hébergé sans fil, si l’appel à la fonction WlanHostedNetworkQueryProperty réussit. La valeur retournée est un type énuméré dans l’énumération WLAN_OPCODE_VALUE_TYPE définie dans le fichier d’en-tête Wlanapi.h .

pvReserved

Réservé pour un usage futur. Ce paramètre doit avoir la valeur NULL.

Valeur retournée

Si la fonction réussit, la valeur de retour est ERROR_SUCCESS.

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

Code de retour	Description
ERROR_BAD_CONFIGURATION	Les données de configuration du réseau hébergé sans fil ne sont pas configurées. Cette erreur est retournée si l’application appelle la fonction WlanHostedNetworkQueryProperty avec le paramètre OpCode défini sur wlan_hosted_network_opcode_station_profile ou wlan_hosted_network_opcode_connection_settings avant qu’un SSID ne soit configuré dans le réseau hébergé sans fil.
ERROR_INVALID_HANDLE	Un handle n’est pas valide. Cette erreur est retournée si le handle spécifié dans le paramètre hClientHandle n’a pas été trouvé dans la table handle.
ERROR_INVALID_PARAMETER	Un paramètre est incorrect. Cette erreur est retournée si l’une des conditions suivantes se produit : hClientHandle a lavaleur NULL. OpCode n’est pas l’une des valeurs énumérées définies dans le WLAN_HOSTED_NETWORK_OPCODE. pdwDataSize a la valeur NULL. ppvData a la valeur NULL. pWlanOpcodeValueType a la valeur NULL. pvReserved n’a pas la valeur NULL.
ERROR_INVALID_STATE	La ressource n’est pas dans l’état correct pour effectuer l’opération demandée. Cela peut se produire si le réseau hébergé sans fil était en cours d’arrêt.
ERROR_OUTOFMEMORY	Espace de stockage insuffisant pour terminer cette opération.
ERROR_SERVICE_NOT_ACTIVE	Le service n'a pas été démarré. Cette erreur est retournée si le service de configuration automatique WLAN n’est pas en cours d’exécution.
Autres	Divers codes d’erreur RPC et autres. Utilisez FormatMessage pour obtenir la chaîne de message pour l’erreur retournée.

Remarques

La fonction WlanHostedNetworkQueryProperty est une extension des API sans fil natives ajoutées pour prendre en charge le réseau hébergé sans fil sur Windows 7 et Windows Server 2008 R2 avec le service LAN sans fil installé.

Une application cliente appelle la fonction WlanHostedNetworkQueryProperty pour interroger les propriétés statiques actuelles du réseau hébergé sans fil. Cette fonction ne modifie pas l’état ou les propriétés du réseau hébergé sans fil.

Si la fonction réussit, le paramètre ppvData pointe vers une mémoire tampon qui contient la propriété demandée. La taille de cette mémoire tampon est retournée dans un pointeur retourné dans le paramètre pwdDataSize . Le WLAN_OPCODE_VALUE_TYPE est retourné dans un pointeur retourné dans le paramètre pWlanOpcodeValueType . La mémoire utilisée pour la mémoire tampon dans le paramètre ppvData retourné doit être libérée en appelant la fonction WlanFreeMemory une fois que la mémoire tampon n’est plus nécessaire.

Le type de données associé à la mémoire tampon pointée par le paramètre ppvData dépend de la valeur du paramètre OpCode comme suit :

OpCode	Description
wlan_hosted_network_opcode_connection_settings	Un pointeur vers une structure WLAN_HOSTED_NETWORK_CONNECTION_SETTINGS est retourné.
wlan_hosted_network_opcode_security_settings	Un pointeur vers une structure WLAN_HOSTED_NETWORK_SECURITY_SETTINGS est retourné.
wlan_hosted_network_opcode_station_profile	Un PWSTR contenant un profil WLAN XML pour la connexion au réseau hébergé sans fil est retourné.
wlan_hosted_network_opcode_enable	Un PBOOL qui indique si le réseau hébergé sans fil est activé est retourné.

Si la fonction WlanHostedNetworkQueryProperty reçoit l’une des valeurs suivantes dans le paramètre OpCode avant qu’un SSID ne soit configuré dans le réseau hébergé sans fil, la fonction échoue avec ERROR_BAD_CONFIGURATION :

wlan_hosted_network_opcode_station_profile
wlan_hosted_network_opcode_connection_settings

Tout utilisateur peut appeler la fonction WlanHostedNetworkQueryProperty pour interroger les propriétés du réseau hébergé.

Sur Windows 7 et versions ultérieures, le système d’exploitation installe un appareil virtuel si une carte sans fil compatible réseau hébergé est présente sur l’ordinateur. Cet appareil virtuel s’affiche normalement dans le dossier « Network Connections » sous la forme « Connexion réseau sans fil 2 » avec le nom de l’appareil « Microsoft Virtual WiFi Miniport adapter » si l’ordinateur dispose d’une seule carte réseau sans fil. Cet appareil virtuel est utilisé exclusivement pour effectuer des connexions de point d’accès logiciel (SoftAP) et n’est pas présent dans la liste retournée par la fonction WlanEnumInterfaces . La durée de vie de cet appareil virtuel est liée à l’adaptateur sans fil physique. Si l’adaptateur sans fil physique est désactivé, cet appareil virtuel sera également supprimé. Cette fonctionnalité est également disponible sur Windows Server 2008 R2 avec le service LAN sans fil installé.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 7 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 R2 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	wlanapi.h (inclure Wlanapi.h)
Bibliothèque	Wlanapi.lib
DLL	Wlanapi.dll