WlanSetProfileEapUserData-Funktion (wlanapi.h)

Artikel
03/04/2024

Die WlanSetProfileEapUserData-Funktion legt die EAP-Benutzeranmeldeinformationen (Extensible Authentication Protocol) fest, wie in EAP-Rohdaten angegeben. Die Benutzeranmeldeinformationen gelten für ein Profil auf einer Benutzeroberfläche.

Syntax

DWORD WlanSetProfileEapUserData(
  [in] HANDLE          hClientHandle,
  [in] const GUID      *pInterfaceGuid,
  [in] LPCWSTR         strProfileName,
  [in] EAP_METHOD_TYPE eapType,
  [in] DWORD           dwFlags,
  [in] DWORD           dwEapUserDataSize,
  [in] const LPBYTE    pbEapUserData,
       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.

[in] eapType

Eine EAP_METHOD_TYPE-Struktur , die die Methode enthält, für die der Aufrufer EAP-Benutzeranmeldeinformationen bereitstellt.

[in] dwFlags

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

Unter 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] dwEapUserDataSize

Die Größe der Daten in Bytes, auf die pbEapUserData verweist.

[in] pbEapUserData

Ein Zeiger auf die EAP-Rohdaten, die zum Festlegen der Benutzeranmeldeinformationen verwendet werden.

Unter Windows Vista und Windows Server 2008 darf dieser Parameter nicht NULL sein.

Unter Windows 7, Windows Server 2008 R2 und höher kann dieser Parameter auf NULL festgelegt werden, um die gespeicherten Anmeldeinformationen für dieses Profil zu löschen, wenn der dwFlags-ParameterWLAN_SET_EAPHOST_DATA_ALL_USERS und der dwEapUserDataSize-Parameter 0 ist.

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_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. pvReserved ist nicht NULL. Unter Windows Vista und Windows Server 2008 wird dieser Wert zurückgegeben, wenn der pbEapUserData-ParameterNULL ist. Unter Windows 7, Windows Server 2008 R2 und höher wird dieser Fehler zurückgegeben, wenn der pbEapUserData-ParameterNULL ist, der dwEapUserDataSize-Parameter jedoch nicht 0 ist oder der dwFlags-Parameter keine WLAN_SET_EAPHOST_DATA_ALL_USERS enthält.
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 oder wenn die Anforderung die gespeicherten Anmeldeinformationen für dieses Profil löschen sollte (der pbEapUserData-Parameter war NULL, der dwFlags-Parameter enthält WLAN_SET_EAPHOST_DATA_ALL_USERS und der dwEapUserDataSize-Parameter ist 0). Auf Windows 10, Windows Server 2016 und höher wird dieser Wert zurückgegeben, wenn die WlanSetProfileEapUserData-Funktion für ein Profil aufgerufen wurde, das eine andere Methode als 802.1X für die Authentifizierung verwendet. Dieser Wert wird auch zurückgegeben, wenn diese Funktion von einem Windows XP mit SP3 oder einer Wlan-LAN-API für Windows XP mit SP2-Client aufgerufen wurde.
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 WlanSetProfileEapUserData-Funktion legt die EAP-Benutzeranmeldeinformationen fest, die für ein Profil verwendet werden sollen. 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 .

Unter Windows 7, Windows Server 2008 R2 und höher wird die WlanSetProfileEapUserData-Funktion verbessert. EAP-Benutzeranmeldeinformationen können für alle Benutzer eines Profils festgelegt werden, wenn der dwFlags-ParameterWLAN_SET_EAPHOST_DATA_ALL_USERS enthält. Die EAP-Benutzeranmeldeinformationen für ein Profil können auch gelöscht werden. Um die EAP-Benutzeranmeldeinformationen für ein Profil zu löschen, muss der pbEapUserData-ParameterNULL, der dwFlags-Parametermuss gleich WLAN_SET_EAPHOST_DATA_ALL_USERS und der dwEapUserDataSize-Parameter 0 sein.

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

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [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