Función WlanSetProfileCustomUserData (wlanapi.h)

Artículo
03/15/2023

La función WlanSetProfileCustomUserData establece los datos de usuario personalizados asociados a un perfil.

Sintaxis

DWORD WlanSetProfileCustomUserData(
  [in] HANDLE      hClientHandle,
  [in] const GUID  *pInterfaceGuid,
  [in] LPCWSTR     strProfileName,
  [in] DWORD       dwDataSize,
  [in] const PBYTE pData,
       PVOID       pReserved
);

Parámetros

[in] hClientHandle

Identificador de sesión del cliente, obtenido por una llamada anterior a la función WlanOpenHandle .

[in] pInterfaceGuid

GUID de la interfaz.

[in] strProfileName

Nombre del perfil asociado a los datos de usuario personalizados. Los nombres de perfil distinguen mayúsculas de minúsculas. Esta cadena debe terminar en NULL.

[in] dwDataSize

Tamaño de pData, en bytes.

[in] pData

Puntero a los datos de usuario que se van a establecer.

pReserved

Reservado para uso futuro. Debe establecerse en NULL.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es ERROR_SUCCESS.

Si se produce un error en la función, el valor devuelto puede ser uno de los siguientes códigos de retorno.

Código devuelto	Descripción
ERROR_INVALID_PARAMETER	Se produjo una de las siguientes condiciones: hClientHandle es NULL o no es válido. pInterfaceGuid es NULL. strProfileName es NULL. pReserved no es NULL. dwDataSize no es 0 y pData es NULL.
ERROR_INVALID_HANDLE	El identificador hClientHandle no se encontró en la tabla de identificadores.
ERROR_NOT_SUPPORTED	Se llamó a esta función desde una plataforma no admitida. Este valor se devolverá si se llamó a esta función desde un Windows XP con SP3 o LAN inalámbrica API para Windows XP con el cliente SP2.
RPC_STATUS	Varios códigos de error.

Comentarios

Para cada perfil inalámbrico WLAN usado por el servicio Native Wifi AutoConfig, Windows mantiene el concepto de datos de usuario personalizados. Estos datos de usuario personalizados no existen inicialmente, pero se pueden establecer llamando a la función WlanSetProfileCustomUserData . Los datos de usuario personalizados se restablecen a vacíos cada vez que se modifica el perfil mediante una llamada a la función WlanSetProfile .

Una vez establecidos los datos de usuario personalizados, se puede acceder a estos datos mediante la función WlanGetProfileCustomUserData .

Todas las funciones LAN inalámbricas requieren un GUID de interfaz para la interfaz inalámbrica al realizar operaciones de perfil. Cuando se quita una interfaz inalámbrica, su estado se borra del servicio LAN inalámbrico (WLANSVC) y no se pueden realizar operaciones de perfil.

La función WlanSetProfileCustomUserData puede producir un error con ERROR_INVALID_PARAMETER si la interfaz inalámbrica especificada en el parámetro pInterfaceGuid se ha quitado del sistema (un adaptador inalámbrico USB que se ha quitado, por ejemplo).

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	wlanapi.h (incluya Wlanapi.h)
Library	Wlanapi.lib
Archivo DLL	Wlanapi.dll