Fonction WlanSetProfileEapXmlUserData (wlanapi.h)

Article
03/04/2024

La fonction WlanSetProfileEapXmlUserData définit les informations d’identification utilisateur EAP (Extensible Authentication Protocol) comme spécifié par une chaîne XML. Les informations d’identification utilisateur s’appliquent à un profil sur une carte. Ces informations d’identification ne peuvent être utilisées que par l’appelant.

Syntaxe

DWORD WlanSetProfileEapXmlUserData(
  [in] HANDLE     hClientHandle,
  [in] const GUID *pInterfaceGuid,
  [in] LPCWSTR    strProfileName,
  [in] DWORD      dwFlags,
  [in] LPCWSTR    strEapXmlUserData,
       PVOID      pReserved
);

Paramètres

[in] hClientHandle

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

[in] pInterfaceGuid

GUID de l’interface.

[in] strProfileName

Nom du profil associé aux données utilisateur EAP. Les noms de profil respectent la casse. Cette chaîne doit être terminée par null.

Windows XP avec SP3 et API LAN sans fil pour Windows XP avec SP2 : Le nom fourni doit correspondre au nom de profil dérivé automatiquement du SSID du réseau. Pour un profil réseau d’infrastructure, le SSID doit être fourni pour le nom du profil. Pour un profil réseau ad hoc, le nom fourni doit être le SSID du réseau ad hoc suivi de -adhoc.

[in] dwFlags

Ensemble d’indicateurs qui modifient le comportement de la fonction.

Sur l’API LAN sans fil pour Windows XP avec SP2, Windows XP avec SP3, Windows Vista et Windows Server 2008, ce paramètre est réservé et doit être défini sur zéro.

Sur Windows 7, Windows Server 2008 R2 et versions ultérieures, ce paramètre peut être l’une des valeurs suivantes.

Valeur	Signification
WLAN_SET_EAPHOST_DATA_ALL_USERS 0x00000001	Définissez les données de l’hôte EAP pour tous les utilisateurs de ce profil.

[in] strEapXmlUserData

Pointeur vers les données XML utilisées pour définir les informations d’identification de l’utilisateur.

Les données XML doivent être basées sur le schéma informations d’identification de l’utilisateur EAPHost. Pour afficher des exemples de données XML d’informations d’identification utilisateur, consultez Propriétés utilisateur EAPHost.

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 ERROR_SUCCESS.

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

Code de retour	Description
ERROR_ACCESS_DENIED	L’accès est refusé. Cette valeur est retournée si l’appelant n’a pas d’accès en écriture au profil.
ERROR_BAD_PROFILE	Le profil de connexion réseau est endommagé. Cette erreur est retournée si le profil spécifié dans le paramètre strProfileName n’a pas pu être analysé.
ERROR_INVALID_PARAMETER	Un paramètre est incorrect. Cette valeur est retournée si l’une des conditions suivantes se produit : hClientHandle a lavaleur NULL. pInterfaceGuid a la valeur NULL. strProfileName a la valeur NULL. strEapXmlUserData a la valeur NULL. pReserved n’a pas la valeur NULL.
ERROR_INVALID_HANDLE	Un handle n’est pas valide. Cette erreur est retournée si le handle hClientHandle est introuvable dans la table handle.
ERROR_NOT_ENOUGH_MEMORY	Le stockage disponible est insuffisant pour traiter cette commande.
ERROR_NOT_SUPPORTED	La demande n'est pas prise en charge. Cette valeur est retournée lorsque les paramètres de profil n’autorisent pas le stockage des données utilisateur. Cela peut se produire lorsque l’authentification unique (SSO) est activée. Sur Windows 7, Windows Server 2008 R2 et versions ultérieures, cette valeur est retournée si la fonction WlanSetProfileEapXmlUserData a été appelée sur un profil qui utilise une méthode autre que 802.1X pour l’authentification.
ERROR_SERVICE_NOT_ACTIVE	Le service n'a pas été démarré. Cette valeur est retournée si le service LAN sans fil n’est pas en cours d’exécution.
RPC_STATUS	Différents codes d’erreur.

Remarques

La fonction WlanSetProfileEapXmlUserData définit les informations d’identification de l’utilisateur EAP à utiliser sur un profil. Cette fonction peut être appelée uniquement sur un profil qui utilise 802.1X pour l’authentification. Sur Windows Vista et Windows Server 2008, ces informations d’identification ne peuvent être utilisées que par l’appelant.

Le paramètre eapType est une structure EAP_METHOD_TYPE qui contient des informations sur le type, l’identification et l’auteur d’une méthode EAP. Le membre eapType de la structure EAP_METHOD_TYPE est une structure EAP_TYPE qui contient les informations d’identification du type et du fournisseur d’une méthode EAP.

Pour plus d’informations sur l’allocation des types de méthodes EAP, consultez la section 6.2 de la RFC 3748 publiée par l’IETF.

À Windows 10, Windows Server 2016 et versions ultérieures, la fonction WlanSetProfileEapXmlUserData est améliorée. Les informations d’identification de l’utilisateur EAP peuvent être définies pour tous les utilisateurs d’un profil si le paramètre dwFlags contient WLAN_SET_EAPHOST_DATA_ALL_USERS.

Toutes les fonctions LAN sans fil nécessitent un GUID d’interface pour l’interface sans fil lors de l’exécution d’opérations de profil. Lorsqu’une interface sans fil est supprimée, son état est effacé du service LAN sans fil (WLANSVC) et aucune opération de profil n’est possible.

La fonction WlanSetProfileEapXmlUserData peut échouer avec ERROR_INVALID_PARAMETER si l’interface sans fil spécifiée dans le paramètre pInterfaceGuid a été supprimée du système (une carte sans fil USB qui a été supprimée, par exemple).

WlanSetProfileEapXmlUserData peut provoquer un échec de connexion sans fil lorsque vous utilisez EAP-TTLS et que l’API est appelée à partir d’une application 32 bits s’exécutant sur un système d’exploitation 64 bits. Votre application doit être créée pour la même architecture de processeur que le système d’exploitation cible.

Windows XP avec SP3 et API LAN sans fil pour Windows XP avec SP2 : Cette fonction ne peut être utilisée que pour les informations d’identification EAP protégées (PEAP). Il ne peut pas être utilisé pour d’autres types EAP.

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 (inclure Wlanapi.h)
Bibliothèque	Wlanapi.lib
DLL	Wlanapi.dll
Composant redistribuable	API LAN sans fil pour Windows XP avec SP2