WlanSetProfileCustomUserData-Funktion (wlanapi.h)

Artikel
03/13/2024

Die WlanSetProfileCustomUserData-Funktion legt die benutzerdefinierten Benutzerdaten fest, die einem Profil zugeordnet sind.

Syntax

DWORD WlanSetProfileCustomUserData(
  [in] HANDLE      hClientHandle,
  [in] const GUID  *pInterfaceGuid,
  [in] LPCWSTR     strProfileName,
  [in] DWORD       dwDataSize,
  [in] const PBYTE pData,
       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 benutzerdefinierten Benutzerdaten zugeordnet ist. Bei Profilnamen wird die Groß-/Kleinschreibung beachtet. Diese Zeichenfolge muss NULL-beendet sein.

[in] dwDataSize

Die Größe von pData in Bytes.

[in] pData

Ein Zeiger auf die festzulegenden Benutzerdaten.

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_INVALID_PARAMETER	Eine der folgenden Bedingungen ist aufgetreten: hClientHandle ist NULL oder ungültig. pInterfaceGuid ist NULL. strProfileName ist NULL. pReserved ist nicht NULL. dwDataSize ist nicht 0 und pData ist NULL.
ERROR_INVALID_HANDLE	Das Handle hClientHandle wurde in der Handle-Tabelle nicht gefunden.
ERROR_NOT_SUPPORTED	Diese Funktion wurde von einer nicht unterstützten Plattform aufgerufen. Dieser Wert wird zurückgegeben, wenn diese Funktion von einem Windows XP-Client mit SP3 oder einer Wlan-LAN-API für Windows XP mit SP2-Client aufgerufen wurde.
RPC_STATUS	Verschiedene Fehlercodes.

Hinweise

Für jedes drahtlose WLAN-Profil, das vom Native Wifi AutoConfig-Dienst verwendet wird, behält Windows das Konzept der benutzerdefinierten Benutzerdaten bei. Diese benutzerdefinierten Benutzerdaten sind zunächst nicht vorhanden, können aber durch Aufrufen der WlanSetProfileCustomUserData-Funktion festgelegt werden. Die benutzerdefinierten Benutzerdaten werden jedes Mal auf leer zurückgesetzt, wenn das Profil durch Aufrufen der WlanSetProfile-Funktion geändert wird.

Nachdem benutzerdefinierte Benutzerdaten festgelegt wurden, kann mit der Funktion WlanGetProfileCustomUserData auf diese Daten zugegriffen werden.

Alle Drahtlos-LAN-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 aus WLANSVC (Wireless LAN Service) gelöscht, und es sind keine Profilvorgänge möglich.

Die WlanSetProfileCustomUserData-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 (einschließlich Wlanapi.h)
Bibliothek	Wlanapi.lib
DLL	Wlanapi.dll