Função WlanSetProfileEapXmlUserData (wlanapi.h)

Artigo
08/28/2023

A função WlanSetProfileEapXmlUserData define as credenciais de usuário do Protocolo de Autenticação Extensível (EAP), conforme especificado por uma cadeia de caracteres XML. As credenciais do usuário se aplicam a um perfil em um adaptador. Essas credenciais só podem ser usadas pelo chamador.

Sintaxe

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

Parâmetros

[in] hClientHandle

O identificador de sessão do cliente, obtido por uma chamada anterior para a função WlanOpenHandle .

[in] pInterfaceGuid

O GUID da interface.

[in] strProfileName

O nome do perfil associado aos dados do usuário do EAP. Os nomes de perfil diferenciam maiúsculas de minúsculas. Essa cadeia de caracteres deve ser terminada em NULL.

Windows XP com SP3 e API lan sem fio para Windows XP com SP2: O nome fornecido deve corresponder ao nome do perfil derivado automaticamente do SSID da rede. Para um perfil de rede de infraestrutura, o SSID deve ser fornecido para o nome do perfil. Para um perfil de rede ad hoc, o nome fornecido deve ser o SSID da rede ad hoc seguido por -adhoc.

[in] dwFlags

Um conjunto de sinalizadores que modificam o comportamento da função.

Na API lan sem fio para Windows XP com SP2, Windows XP com SP3, Windows Vista e Windows Server 2008, esse parâmetro é reservado e deve ser definido como zero.

No Windows 7, Windows Server 2008 R2 e posterior, esse parâmetro pode ser um dos valores a seguir.

Valor	Significado
WLAN_SET_EAPHOST_DATA_ALL_USERS 0x00000001	Defina dados de host EAP para todos os usuários desse perfil.

[in] strEapXmlUserData

Um ponteiro para dados XML usados para definir as credenciais do usuário.

Os dados XML devem ser baseados no esquema de Credenciais de Usuário do EAPHost. Para exibir dados XML de credencial de usuário de exemplo, consulte Propriedades do usuário do EAPHost.

pReserved

Reservado para uso futuro. Deve ser definido como NULL.

Retornar valor

Se a função obtiver êxito, o valor retornado será ERROR_SUCCESS.

Se a função falhar, o valor retornado poderá ser um dos seguintes códigos de retorno.

Código de retorno	Descrição
ERROR_ACCESS_DENIED	Acesso negado. Esse valor será retornado se o chamador não tiver acesso de gravação ao perfil.
ERROR_BAD_PROFILE	O perfil de conexão de rede está corrompido. Esse erro será retornado se o perfil especificado no parâmetro strProfileName não puder ser analisado.
ERROR_INVALID_PARAMETER	Um parâmetro está incorreto. Esse valor será retornado se qualquer uma das seguintes condições ocorrer: hClientHandle é NULL. pInterfaceGuid é NULL. strProfileName é NULL. strEapXmlUserData é NULL. pReserved não é NULL.
ERROR_INVALID_HANDLE	Um identificador é inválido. Esse erro será retornado se o identificador hClientHandle não tiver sido encontrado na tabela de identificadores.
ERROR_NOT_ENOUGH_MEMORY	Não há armazenamento suficiente disponível para processar esse comando.
ERROR_NOT_SUPPORTED	A solicitação não terá suporte. Esse valor é retornado quando as configurações de perfil não permitem o armazenamento de dados do usuário. Isso pode ocorrer quando o SSO (logon único) está habilitado. No Windows 7, Windows Server 2008 R2 e posterior, esse valor será retornado se a função WlanSetProfileEapXmlUserData foi chamada em um perfil que usa um método diferente de 802.1X para autenticação.
ERROR_SERVICE_NOT_ACTIVE	O serviço não foi iniciado. Esse valor será retornado se o serviço lan sem fio não estiver em execução.
RPC_STATUS	Vários códigos de erro.

Comentários

A função WlanSetProfileEapXmlUserData define as credenciais de usuário do EAP a serem usadas em um perfil. Essa função só pode ser chamada em um perfil que usa 802.1X para autenticação. No Windows Vista e no Windows Server 2008, essas credenciais só podem ser usadas pelo chamador.

O parâmetro eapType é uma estrutura EAP_METHOD_TYPE que contém informações de tipo, identificação e autor sobre um método EAP. O membro eapType da estrutura EAP_METHOD_TYPE é uma estrutura EAP_TYPE que contém as informações de identificação do tipo e do fornecedor para um método EAP.

Para obter mais informações sobre a alocação de tipos de método EAP, consulte a seção 6.2 do RFC 3748 publicado pelo IETF.

Em Windows 10, Windows Server 2016 e posterior, a função WlanSetProfileEapXmlUserData é aprimorada. As credenciais de usuário do EAP poderão ser definidas para todos os usuários de um perfil se o parâmetro dwFlagscontiver WLAN_SET_EAPHOST_DATA_ALL_USERS.

Todas as funções lan sem fio exigem um GUID de interface para a interface sem fio ao executar operações de perfil. Quando uma interface sem fio é removida, seu estado é removido do WLANSVC (Wireless LAN Service) e nenhuma operação de perfil é possível.

A função WlanSetProfileEapXmlUserData poderá falhar com ERROR_INVALID_PARAMETER se a interface sem fio especificada no parâmetro pInterfaceGuid tiver sido removida do sistema (um adaptador sem fio USB que foi removido, por exemplo).

O WlanSetProfileEapXmlUserData pode causar falha de conexão sem fio quando você usa EAP-TTLS e a API é chamada de um aplicativo de 32 bits em execução em um so (sistema operacional) de 64 bits. Seu aplicativo deve ser criado para a mesma arquitetura de CPU que o sistema operacional de destino.

Windows XP com SP3 e API lan sem fio para Windows XP com SP2: Essa função só pode ser usada para credenciais PEAP (Protected EAP). Ele não pode ser usado para outros tipos de EAP.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista, Windows XP com SP3 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	wlanapi.h (inclua Wlanapi.h)
Biblioteca	Wlanapi.lib
DLL	Wlanapi.dll
Redistribuível	API de LAN sem fio para Windows XP com SP2