Fonction WlanSetProfileCustomUserData (wlanapi.h)

Article
03/04/2024

La fonction WlanSetProfileCustomUserData définit les données utilisateur personnalisées associées à un profil.

Syntaxe

DWORD WlanSetProfileCustomUserData(
  [in] HANDLE      hClientHandle,
  [in] const GUID  *pInterfaceGuid,
  [in] LPCWSTR     strProfileName,
  [in] DWORD       dwDataSize,
  [in] const PBYTE pData,
       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 personnalisées. Les noms de profil respectent la casse. Cette chaîne doit être terminée par null.

[in] dwDataSize

Taille de pData, en octets.

[in] pData

Pointeur vers les données utilisateur à définir.

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_INVALID_PARAMETER	L’une des conditions suivantes s’est produite : hClientHandle a la valeur NULL ou non valide. pInterfaceGuid a la valeur NULL. strProfileName a la valeur NULL. pReserved n’a pas la valeur NULL. dwDataSize n’est pas 0 et pData a la valeur NULL.
ERROR_INVALID_HANDLE	Le handle hClientHandle est introuvable dans la table handle.
ERROR_NOT_SUPPORTED	Cette fonction a été appelée à partir d’une plateforme non prise en charge. Cette valeur sera retournée si cette fonction a été appelée à partir d’un windows XP avec l’API LAN sans fil ou SP3 pour Windows XP avec le client SP2.
RPC_STATUS	Différents codes d’erreur.

Remarques

Pour chaque profil WLAN sans fil utilisé par le service Native Wifi AutoConfig, Windows conserve le concept de données utilisateur personnalisées. Ces données utilisateur personnalisées sont initialement inexistantes, mais peuvent être définies en appelant la fonction WlanSetProfileCustomUserData . Les données utilisateur personnalisées sont réinitialisées pour qu’elles se vident chaque fois que le profil est modifié en appelant la fonction WlanSetProfile .

Une fois les données utilisateur personnalisées définies, ces données sont accessibles à l’aide de la fonction WlanGetProfileCustomUserData .

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 WlanSetProfileCustomUserData 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 (inclure Wlanapi.h)
Bibliothèque	Wlanapi.lib
DLL	Wlanapi.dll