Funzione WlanSetProfileEapXmlUserData (wlanapi.h)

Articolo
03/04/2024

La funzione WlanSetProfileEapXmlUserData imposta le credenziali utente di Extensible Authentication Protocol (EAP) come specificato da una stringa XML. Le credenziali utente si applicano a un profilo in un adattatore. Queste credenziali possono essere usate solo dal chiamante.

Sintassi

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

Parametri

[in] hClientHandle

Handle di sessione del client ottenuto da una chiamata precedente alla funzione WlanOpenHandle .

[in] pInterfaceGuid

GUID dell'interfaccia.

[in] strProfileName

Nome del profilo associato ai dati utente EAP. I nomi dei profili sono distinzione tra maiuscole e minuscole. Questa stringa deve essere terminata con null.

Windows XP con SP3 e API LAN wireless per Windows XP con SP2: Il nome specificato deve corrispondere al nome del profilo derivato automaticamente dall'SSID della rete. Per un profilo di rete dell'infrastruttura, è necessario specificare SSID per il nome del profilo. Per un profilo di rete ad hoc, il nome specificato deve essere SSID della rete ad hoc seguita da -adhoc.

[in] dwFlags

Set di flag che modificano il comportamento della funzione.

Nell'API LAN wireless per Windows XP con SP2, Windows XP con SP3, Windows Vista e Windows Server 2008, questo parametro è riservato e deve essere impostato su zero.

In Windows 7, Windows Server 2008 R2 e versioni successive, questo parametro può essere uno dei valori seguenti.

Valore	Significato
WLAN_SET_EAPHOST_DATA_ALL_USERS 0x00000001	Impostare i dati host EAP per tutti gli utenti di questo profilo.

[in] strEapXmlUserData

Puntatore ai dati XML usati per impostare le credenziali utente.

I dati XML devono essere basati sullo schema credenziali utente EAPHost. Per visualizzare i dati XML delle credenziali utente di esempio, vedere Proprietà utente EAPHost.

pReserved

Riservato per utilizzi futuri. Deve essere impostato su NULL.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è ERROR_SUCCESS.

Se la funzione ha esito negativo, il valore restituito può essere uno dei codici restituiti seguenti.

Codice restituito	Descrizione
ERROR_ACCESS_DENIED	Accesso negato. Questo valore viene restituito se il chiamante non ha accesso in scrittura al profilo.
ERROR_BAD_PROFILE	Il profilo di connessione di rete è danneggiato. Questo errore viene restituito se il profilo specificato nel parametro strProfileName non è stato possibile analizzare.
ERROR_INVALID_PARAMETER	Un parametro non è corretto. Questo valore viene restituito se si verificano una delle condizioni seguenti: hClientHandle è NULL. pInterfaceGuid è NULL. strProfileName è NULL. strEapXmlUserData è NULL. pReserved non è NULL.
ERROR_INVALID_HANDLE	Un handle non è valido. Questo errore viene restituito se l'handle hClientHandle non è stato trovato nella tabella handle.
ERROR_NOT_ENOUGH_MEMORY	L'archiviazione non è sufficiente per elaborare questo comando.
ERROR_NOT_SUPPORTED	La richiesta non è supportata. Questo valore viene restituito quando le impostazioni del profilo non consentono l'archiviazione dei dati utente. Ciò può verificarsi quando è abilitato l'accesso Single Signon (SSO). In Windows 7, Windows Server 2008 R2 e versioni successive, questo valore viene restituito se la funzione WlanSetProfileEapXmlUserData è stata chiamata su un profilo che usa un metodo diverso da 802.1X per l'autenticazione.
ERROR_SERVICE_NOT_ACTIVE	Il servizio non è stato avviato. Questo valore viene restituito se il servizio LAN wireless non è in esecuzione.
RPC_STATUS	Vari codici di errore.

Commenti

La funzione WlanSetProfileEapXmlUserData imposta le credenziali utente EAP da usare in un profilo. Questa funzione può essere chiamata solo in un profilo che usa 802.1X per l'autenticazione. In Windows Vista e Windows Server 2008 queste credenziali possono essere usate solo dal chiamante.

Il parametro eapType è una struttura EAP_METHOD_TYPE che contiene informazioni di tipo, identificazione e autore su un metodo EAP. Il membro eapType della struttura EAP_METHOD_TYPE è una struttura EAP_TYPE che contiene le informazioni di identificazione del tipo e del fornitore per un metodo EAP.

Per altre informazioni sull'allocazione dei tipi di metodo EAP, vedere la sezione 6.2 di RFC 3748 pubblicata da IETF.

In Windows 10, Windows Server 2016 e versioni successive, la funzione WlanSetProfileEapXmlUserData è migliorata. Le credenziali utente EAP possono essere impostate per tutti gli utenti di un profilo se il parametro dwFlags contiene WLAN_SET_EAPHOST_DATA_ALL_USERS.

Tutte le funzioni LAN wireless richiedono un GUID di interfaccia per l'interfaccia wireless durante l'esecuzione delle operazioni del profilo. Quando un'interfaccia wireless viene rimossa, lo stato viene cancellato dal servizio LAN wireless (WLANSVC) e non sono possibili operazioni di profilo.

La funzione WlanSetProfileEapXmlUserData può non riuscire con ERROR_INVALID_PARAMETER se l'interfaccia wireless specificata nel parametro pInterfaceGuid è stata rimossa dal sistema (ad esempio una scheda wireless USB rimossa).

WlanSetProfileEapXmlUserData potrebbe causare un errore di connessione wireless quando si usa EAP-TTLS e l'API viene chiamata da un'applicazione a 32 bit in esecuzione in un sistema operativo a 64 bit. L'applicazione deve essere compilata per la stessa architettura della CPU del sistema operativo di destinazione.

Windows XP con SP3 e API LAN wireless per Windows XP con SP2: Questa funzione può essere usata solo per le credenziali PEAP (Protected EAP). Non può essere usato per altri tipi EAP.

Requisiti

Requisito	Valore
Client minimo supportato	Windows Vista, Windows XP con SP3 [solo app desktop]
Server minimo supportato	Windows Server 2008 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	wlanapi.h (include Wlanapi.h)
Libreria	Wlanapi.lib
DLL	Wlanapi.dll
Componente ridistribuibile	API LAN wireless per Windows XP con SP2