Función WlanSetProfileEapXmlUserData (wlanapi.h)

Artículo
03/04/2024

La función WlanSetProfileEapXmlUserData establece las credenciales de usuario del Protocolo de autenticación extensible (EAP) como se especifica en una cadena XML. Las credenciales de usuario se aplican a un perfil en un adaptador. Estas credenciales solo las puede usar el autor de la llamada.

Sintaxis

DWORD WlanSetProfileEapXmlUserData(
  [in] HANDLE     hClientHandle,
  [in] const GUID *pInterfaceGuid,
  [in] LPCWSTR    strProfileName,
  [in] DWORD      dwFlags,
  [in] LPCWSTR    strEapXmlUserData,
       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 de EAP. Los nombres de perfil distinguen mayúsculas de minúsculas. Esta cadena debe terminar en NULL.

Windows XP con SP3 y LAN inalámbrica API para Windows XP con SP2: El nombre proporcionado debe coincidir con el nombre del perfil derivado automáticamente del SSID de la red. Para un perfil de red de infraestructura, se debe proporcionar el SSID para el nombre del perfil. Para un perfil de red ad hoc, el nombre proporcionado debe ser el SSID de la red ad hoc seguida de -adhoc.

[in] dwFlags

Conjunto de marcas que modifican el comportamiento de la función.

En la API LAN inalámbrica para Windows XP con SP2, Windows XP con SP3, Windows Vista y Windows Server 2008, este parámetro está reservado y debe establecerse en cero.

En Windows 7, Windows Server 2008 R2 y versiones posteriores, este parámetro puede ser uno de los valores siguientes.

Valor	Significado
WLAN_SET_EAPHOST_DATA_ALL_USERS 0x00000001	Establezca los datos de host de EAP para todos los usuarios de este perfil.

[in] strEapXmlUserData

Puntero a datos XML usados para establecer las credenciales de usuario.

Los datos XML deben basarse en el esquema de credenciales de usuario de EAPHost. Para ver datos XML de credenciales de usuario de ejemplo, consulte Propiedades de usuario de EAPHost.

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_ACCESS_DENIED	Acceso denegado. Este valor se devuelve si el autor de la llamada no tiene acceso de escritura al perfil.
ERROR_BAD_PROFILE	El perfil de conexión de red está dañado. Este error se devuelve si no se pudo analizar el perfil especificado en el parámetro strProfileName .
ERROR_INVALID_PARAMETER	Un parámetro es incorrecto. Este valor se devuelve si se produce alguna de las condiciones siguientes: hClientHandle es NULL. pInterfaceGuid es NULL. strProfileName es NULL. strEapXmlUserData es NULL. pReserved no es NULL.
ERROR_INVALID_HANDLE	Un identificador no es válido. Este error se devuelve si no se encontró el identificador hClientHandle en la tabla de identificadores.
ERROR_NOT_ENOUGH_MEMORY	No hay suficiente almacenamiento disponible para procesar este comando.
ERROR_NOT_SUPPORTED	No se admite la solicitud. Este valor se devuelve cuando la configuración del perfil no permite el almacenamiento de datos de usuario. Esto puede ocurrir cuando se habilita el inicio de sesión único (SSO). En Windows 7, Windows Server 2008 R2 y versiones posteriores, este valor se devuelve si se llamó a la función WlanSetProfileEapXmlUserData en un perfil que usa un método distinto de 802.1X para la autenticación.
ERROR_SERVICE_NOT_ACTIVE	El servicio no se ha iniciado. Este valor se devuelve si el servicio LAN inalámbrico no se está ejecutando.
RPC_STATUS	Varios códigos de error.

Comentarios

La función WlanSetProfileEapXmlUserData establece las credenciales de usuario de EAP que se usarán en un perfil. Solo se puede llamar a esta función en un perfil que use 802.1X para la autenticación. En Windows Vista y Windows Server 2008, el autor de la llamada solo puede usar estas credenciales.

El parámetro eapType es una estructura EAP_METHOD_TYPE que contiene información de tipo, identificación y autor sobre un método EAP. El miembro eapType de la estructura EAP_METHOD_TYPE es una estructura de EAP_TYPE que contiene la información de identificación del tipo y del proveedor para un método EAP.

Para obtener más información sobre la asignación de tipos de método EAP, vea la sección 6.2 de RFC 3748 publicada por IETF.

En Windows 10, Windows Server 2016 y versiones posteriores, se mejora la función WlanSetProfileEapXmlUserData. Las credenciales de usuario de EAP se pueden establecer para todos los usuarios de un perfil si el parámetro dwFlags contiene WLAN_SET_EAPHOST_DATA_ALL_USERS.

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 WlanSetProfileEapXmlUserData 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).

WlanSetProfileEapXmlUserData puede provocar un error de conexión inalámbrica cuando se usa EAP-TTLS y se llama a la API desde una aplicación de 32 bits que se ejecuta en un sistema operativo de 64 bits (SO). La aplicación debe compilarse para la misma arquitectura de CPU que el sistema operativo de destino.

Windows XP con SP3 y LAN inalámbrica API para Windows XP con SP2: Esta función solo se puede usar para las credenciales de EAP protegido (PEAP). No se puede usar para otros tipos de EAP.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista, Windows XP con SP3 [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
Redistribuible	API LAN inalámbrica para Windows XP con SP2