Fonction WlanSetProfileEapUserData (wlanapi.h)

Article
08/28/2023

La fonction WlanSetProfileEapUserData définit les informations d’identification de l’utilisateur EAP (Extensible Authentication Protocol) comme spécifié par les données EAP brutes. Les informations d’identification de l’utilisateur s’appliquent à un profil sur une interface.

Syntaxe

DWORD WlanSetProfileEapUserData(
  [in] HANDLE          hClientHandle,
  [in] const GUID      *pInterfaceGuid,
  [in] LPCWSTR         strProfileName,
  [in] EAP_METHOD_TYPE eapType,
  [in] DWORD           dwFlags,
  [in] DWORD           dwEapUserDataSize,
  [in] const LPBYTE    pbEapUserData,
       PVOID           pReserved
);

Paramètres

[in] hClientHandle

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.

[in] eapType

Structure EAP_METHOD_TYPE qui contient la méthode pour laquelle l’appelant fournit les informations d’identification de l’utilisateur EAP.

[in] dwFlags

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

Sur 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] dwEapUserDataSize

Taille, en octets, des données pointées par pbEapUserData.

[in] pbEapUserData

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

Sur Windows Vista et Windows Server 2008, ce paramètre ne doit pas être NULL.

Sur Windows 7, Windows Server 2008 R2 et versions ultérieures, ce paramètre peut être défini sur NULL pour supprimer les informations d’identification stockées pour ce profil si le paramètre dwFlags contient WLAN_SET_EAPHOST_DATA_ALL_USERS et que le paramètre dwEapUserDataSize a la valeur 0.

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_INVALID_PARAMETER	Un paramètre est incorrect. Cette valeur est retournée si l’une des conditions suivantes se produit : hClientHandle a la valeur NULL. pInterfaceGuid a la valeur NULL. strProfileName a la valeur NULL pvReserved n’est pas NULL. Sur Windows Vista et Windows Server 2008, cette valeur est retournée si le paramètre pbEapUserData a la valeur NULL. Sur Windows 7, Windows Server 2008 R2 et versions ultérieures, cette erreur est retournée si le paramètre pbEapUserData a la valeur NULL, mais que le paramètre dwEapUserDataSize n’a pas la valeur 0 ou si le paramètre dwFlags ne contient pas de WLAN_SET_EAPHOST_DATA_ALL_USERS.
ERROR_INVALID_HANDLE	Un handle n’est pas valide. Cette erreur est retournée si le handle hClientHandle est introuvable dans la table de handle.
ERROR_NOT_ENOUGH_MEMORY	L’espace de 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 ou lorsque la demande a été de supprimer les informations d’identification stockées pour ce profil (le paramètre pbEapUserData était NULL, le paramètre dwFlags contient WLAN_SET_EAPHOST_DATA_ALL_USERS et le paramètre dwEapUserDataSize est 0). Sur Windows 10, Windows Server 2016 et versions ultérieures, cette valeur est retournée si la fonction WlanSetProfileEapUserData a été appelée sur un profil qui utilise une méthode autre que 802.1X pour l’authentification. Cette valeur est également retournée si cette fonction a été appelée à partir d’un windows XP avec SP3 ou API LAN sans fil pour Windows XP avec un client SP2.
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 WlanSetProfileEapUserData définit les informations d’identification de l’utilisateur EAP à utiliser sur un profil. 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.

Sur Windows 7, Windows Server 2008 R2 et versions ultérieures, la fonction WlanSetProfileEapUserData 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. Les informations d’identification de l’utilisateur EAP d’un profil peuvent également être supprimées. Pour supprimer les informations d’identification de l’utilisateur EAP sur un profil, le paramètre pbEapUserData doit être NULL, le paramètre dwFlags doit être égal WLAN_SET_EAPHOST_DATA_ALL_USERS et le paramètre dwEapUserDataSize doit être égal à 0.

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 WlanSetProfileEapUserData 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 (un adaptateur sans fil USB qui a été supprimé, par exemple).

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [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