WlanSetProfileEapXmlUserData-Funktion (wlanapi.h)

Artikel
03/04/2024

Die WlanSetProfileEapXmlUserData-Funktion legt die EAP-Benutzeranmeldeinformationen (Extensible Authentication Protocol) fest, wie durch eine XML-Zeichenfolge angegeben. Die Benutzeranmeldeinformationen gelten für ein Profil auf einem Adapter. Diese Anmeldeinformationen können nur vom Aufrufer verwendet werden.

Syntax

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

Parameter

[in] hClientHandle

Das Sitzungshandle des Clients, das durch einen vorherigen Aufruf der WlanOpenHandle-Funktion abgerufen wurde.

[in] pInterfaceGuid

Die GUID der Schnittstelle.

[in] strProfileName

Der Name des Profils, das den EAP-Benutzerdaten zugeordnet ist. Bei Profilnamen wird die Groß-/Kleinschreibung beachtet. Diese Zeichenfolge muss NULL-endend sein.

Windows XP mit SP3 und Wlan-API für Windows XP mit SP2: Der angegebene Name muss mit dem Profilnamen übereinstimmen, der automatisch von der SSID des Netzwerks abgeleitet wird. Für ein Infrastrukturnetzwerkprofil muss die SSID für den Profilnamen angegeben werden. Für ein Ad-hoc-Netzwerkprofil muss der angegebene Name die SSID des Ad-hoc-Netzwerks gefolgt von -adhocsein.

[in] dwFlags

Ein Satz von Flags, die das Verhalten der Funktion ändern.

In der WLAN-API für Windows XP mit SP2, Windows XP mit SP3, Windows Vista und Windows Server 2008 ist dieser Parameter reserviert und sollte auf null festgelegt werden.

Unter Windows 7, Windows Server 2008 R2 und höher kann dieser Parameter einer der folgenden Werte sein.

Wert	Bedeutung
WLAN_SET_EAPHOST_DATA_ALL_USERS 0x00000001	Legen Sie EAP-Hostdaten für alle Benutzer dieses Profils fest.

[in] strEapXmlUserData

Ein Zeiger auf XML-Daten, die zum Festlegen der Benutzeranmeldeinformationen verwendet werden.

Die XML-Daten müssen auf dem EAPHost-Schema für Benutzeranmeldeinformationen basieren. Informationen zum Anzeigen von XML-Beispieldaten für Benutzeranmeldeinformationen finden Sie unter EAPHost-Benutzereigenschaften.

pReserved

Für die zukünftige Verwendung reserviert. Muss auf NULL festgelegt werden.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert ERROR_SUCCESS.

Wenn die Funktion fehlschlägt, kann der Rückgabewert einer der folgenden Rückgabecodes sein.

Rückgabecode	Beschreibung
ERROR_ACCESS_DENIED	Zugriff verweigert.“ Dieser Wert wird zurückgegeben, wenn der Aufrufer keinen Schreibzugriff auf das Profil hat.
ERROR_BAD_PROFILE	Das Netzwerkverbindungsprofil ist beschädigt. Dieser Fehler wird zurückgegeben, wenn das im strProfileName-Parameter angegebene Profil nicht analysiert werden konnte.
ERROR_INVALID_PARAMETER	Ein Parameter ist falsch. Dieser Wert wird zurückgegeben, wenn eine der folgenden Bedingungen auftritt: hClientHandle ist NULL. pInterfaceGuid ist NULL. strProfileName ist NULL. strEapXmlUserData ist NULL. pReserved ist nicht NULL.
ERROR_INVALID_HANDLE	Ein Handle ist ungültig. Dieser Fehler wird zurückgegeben, wenn das Handle hClientHandle in der Handletabelle nicht gefunden wurde.
ERROR_NOT_ENOUGH_MEMORY	Für die Verarbeitung dieses Befehls ist nicht genügend Speicherplatz verfügbar.
ERROR_NOT_SUPPORTED	Die Anforderung wird nicht unterstützt. Dieser Wert wird zurückgegeben, wenn die Profileinstellungen die Speicherung von Benutzerdaten nicht zulassen. Dies kann auftreten, wenn einmaliges Anmelden (Single Signon, SSO) aktiviert ist. Unter Windows 7, Windows Server 2008 R2 und höher wird dieser Wert zurückgegeben, wenn die WlanSetProfileEapXmlUserData-Funktion für ein Profil aufgerufen wurde, das eine andere Methode als 802.1X für die Authentifizierung verwendet.
ERROR_SERVICE_NOT_ACTIVE	Der Dienst wurde nicht gestartet. Dieser Wert wird zurückgegeben, wenn der WLAN-Dienst nicht ausgeführt wird.
RPC_STATUS	Verschiedene Fehlercodes.

Hinweise

Die WlanSetProfileEapXmlUserData-Funktion legt die EAP-Benutzeranmeldeinformationen fest, die für ein Profil verwendet werden sollen. Diese Funktion kann nur für ein Profil aufgerufen werden, das 802.1X für die Authentifizierung verwendet. Unter Windows Vista und Windows Server 2008 können diese Anmeldeinformationen nur vom Aufrufer verwendet werden.

Der eapType-Parameter ist eine EAP_METHOD_TYPE-Struktur , die Typ-, Identifikations- und Autoreninformationen zu einer EAP-Methode enthält. Das eapType-Element der EAP_METHOD_TYPE-Struktur ist eine EAP_TYPE-Struktur , die die Typ- und Anbieteridentifikationsinformationen für eine EAP-Methode enthält.

Weitere Informationen zur Zuordnung von EAP-Methodentypen finden Sie im Abschnitt 6.2 des von der IETF veröffentlichten RFC 3748 .

Auf Windows 10, Windows Server 2016 und höher wird die WlanSetProfileEapXmlUserData-Funktion erweitert. EAP-Benutzeranmeldeinformationen können für alle Benutzer eines Profils festgelegt werden, wenn der dwFlags-ParameterWLAN_SET_EAPHOST_DATA_ALL_USERS enthält.

Alle WLAN-Funktionen erfordern eine Schnittstellen-GUID für die Drahtlose Schnittstelle, wenn Profilvorgänge ausgeführt werden. Wenn eine drahtlose Schnittstelle entfernt wird, wird ihr Zustand vom Wlan-Dienst (WLANSVC) gelöscht, und es sind keine Profilvorgänge möglich.

Die WlanSetProfileEapXmlUserData-Funktion kann mit ERROR_INVALID_PARAMETER fehlschlagen, wenn die im pInterfaceGuid-Parameter angegebene drahtlose Schnittstelle aus dem System entfernt wurde (z. B. ein USB-Drahtlosadapter, der entfernt wurde).

WlanSetProfileEapXmlUserData kann zu einem Funkverbindungsfehler führen, wenn Sie EAP-TTLS verwenden und die API von einer 32-Bit-Anwendung aufgerufen wird, die unter einem 64-Bit-Betriebssystem ausgeführt wird. Ihre Anwendung sollte für dieselbe CPU-Architektur wie das Zielbetriebssystem erstellt werden.

Windows XP mit SP3 und Wlan-API für Windows XP mit SP2: Diese Funktion kann nur für PEAP-Anmeldeinformationen (Protected EAP) verwendet werden. Es kann nicht für andere EAP-Typen verwendet werden.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista, Windows XP mit SP3 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	wlanapi.h (wlanapi.h einschließen)
Bibliothek	Wlanapi.lib
DLL	Wlanapi.dll
Verteilbare Komponente	Wlan-API für Windows XP mit SP2