WlanHostedNetworkQueryProperty-Funktion (wlanapi.h)

Artikel
03/04/2024

Die WlanHostedNetworkQueryProperty-Funktion fragt die aktuellen statischen Eigenschaften des drahtlos gehosteten Netzwerks ab.

Syntax

DWORD WlanHostedNetworkQueryProperty(
  [in]  HANDLE                     hClientHandle,
  [in]  WLAN_HOSTED_NETWORK_OPCODE OpCode,
  [out] PDWORD                     pdwDataSize,
  [out] PVOID                      *ppvData,
  [out] PWLAN_OPCODE_VALUE_TYPE    pWlanOpcodeValueType,
        PVOID                      pvReserved
);

Parameter

[in] hClientHandle

Das Sitzungshandle des Clients, das von einem vorherigen Aufruf der WlanOpenHandle-Funktion zurückgegeben wurde.

[in] OpCode

Der Bezeichner für die abzufragte Eigenschaft. Dieser Bezeichner kann jeder der Werte in der WLAN_HOSTED_NETWORK_OPCODE-Enumeration sein, die in der Headerdatei "Wlanapi.h " definiert ist.

[out] pdwDataSize

Ein Zeiger auf einen Wert, der die Größe des puffers in Bytes angibt, der im ppvData-Parameter zurückgegeben wird, wenn der Aufruf der WlanHostedNetworkQueryProperty-Funktion erfolgreich ist.

[out] ppvData

Bei der Eingabe muss dieser Parameter NULL sein.

Bei der Ausgabe empfängt dieser Parameter einen Zeiger auf einen Puffer, der mit der angeforderten statischen Eigenschaft zurückgegeben wird, wenn der Aufruf der WlanHostedNetworkQueryProperty-Funktion erfolgreich ist. Der diesem Puffer zugeordnete Datentyp hängt vom Wert des OpCode-Parameters ab.

[out] pWlanOpcodeValueType

Ein Zeiger auf einen Wert, der den Werttyp der Wireless Hosted Network-Eigenschaft empfängt, wenn der Aufruf der WlanHostedNetworkQueryProperty-Funktion erfolgreich ist. Der zurückgegebene Wert ist ein aufgezählter Typ in der WLAN_OPCODE_VALUE_TYPE Enumeration, die in der Headerdatei Wlanapi.h definiert ist.

pvReserved

Für die zukünftige Verwendung reserviert. Dieser Parameter muss NULL sein.

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_BAD_CONFIGURATION	Die Konfigurationsdaten für das drahtlos gehostete Netzwerk sind nicht konfiguriert. Dieser Fehler wird zurückgegeben, wenn die Anwendung die WlanHostedNetworkQueryProperty-Funktion aufruft, wobei der OpCode-Parameter auf wlan_hosted_network_opcode_station_profile oder wlan_hosted_network_opcode_connection_settings festgelegt ist, bevor eine SSID im drahtlosen gehosteten Netzwerk konfiguriert wird.
ERROR_INVALID_HANDLE	Ein Handle ist ungültig. Dieser Fehler wird zurückgegeben, wenn das im hClientHandle-Parameter angegebene Handle nicht in der Handle-Tabelle gefunden wurde.
ERROR_INVALID_PARAMETER	Ein Parameter ist falsch. Dieser Fehler wird zurückgegeben, wenn eine der folgenden Bedingungen auftritt: hClientHandle ist NULL. OpCode gehört nicht zu den aufgezählten Werten, die im WLAN_HOSTED_NETWORK_OPCODE definiert sind. pdwDataSize ist NULL. ppvData ist NULL. pWlanOpcodeValueType ist NULL. pvReserved ist nicht NULL.
ERROR_INVALID_STATE	Die Ressource befindet sich nicht im richtigen Zustand, um den angeforderten Vorgang auszuführen. Dies kann auftreten, wenn das drahtlos gehostete Netzwerk während des Herunterfahrens war.
ERROR_OUTOFMEMORY	Für diesen Vorgang ist nicht genügend Speicher verfügbar.
ERROR_SERVICE_NOT_ACTIVE	Der Dienst wurde nicht gestartet. Dieser Fehler wird zurückgegeben, wenn der WLAN AutoConfig-Dienst nicht ausgeführt wird.
Andere	Verschiedene RPC- und andere Fehlercodes. Verwenden Sie FormatMessage , um die Nachrichtenzeichenfolge für den zurückgegebenen Fehler abzurufen.

Hinweise

Die WlanHostedNetworkQueryProperty-Funktion ist eine Erweiterung für native Drahtlose APIs, die hinzugefügt wurden, um das drahtlose gehostete Netzwerk unter Windows 7 und Windows Server 2008 R2 mit installiertem Wlan-LAN-Dienst zu unterstützen.

Eine Clientanwendung ruft die WlanHostedNetworkQueryProperty-Funktion auf, um die aktuellen statischen Eigenschaften des drahtlosen gehosteten Netzwerks abzufragen. Diese Funktion ändert den Zustand oder die Eigenschaften des drahtlos gehosteten Netzwerks nicht.

Wenn die Funktion erfolgreich ist, verweist der ppvData-Parameter auf einen Puffer, der die angeforderte Eigenschaft enthält. Die Größe dieses Puffers wird in einem Zeiger zurückgegeben, der im pwdDataSize-Parameter zurückgegeben wird. Die WLAN_OPCODE_VALUE_TYPE wird in einem Zeiger zurückgegeben, der im pWlanOpcodeValueType-Parameter zurückgegeben wird. Der für den Puffer im zurückgegebenen ppvData-Parameter verwendete Arbeitsspeicher sollte durch Aufrufen der WlanFreeMemory-Funktion freigegeben werden, nachdem der Puffer nicht mehr benötigt wird.

Der Datentyp, der dem Puffer zugeordnet ist, auf den der ppvData-Parameter verweist, hängt wie folgt vom Wert des OpCode-Parameters ab:

OpCode	BESCHREIBUNG
wlan_hosted_network_opcode_connection_settings	Ein Zeiger auf eine WLAN_HOSTED_NETWORK_CONNECTION_SETTINGS-Struktur wird zurückgegeben.
wlan_hosted_network_opcode_security_settings	Ein Zeiger auf eine WLAN_HOSTED_NETWORK_SECURITY_SETTINGS-Struktur wird zurückgegeben.
wlan_hosted_network_opcode_station_profile	Ein PWSTR-Objekt , das ein XML-WLAN-Profil für die Verbindung mit dem drahtlosen gehosteten Netzwerk enthält, wird zurückgegeben.
wlan_hosted_network_opcode_enable	Es wird ein PBOOL zurückgegeben, das angibt, ob das drahtlos gehostete Netzwerk aktiviert ist.

Wenn die WlanHostedNetworkQueryProperty-Funktion einen der folgenden Werte im OpCode-Parameter übergeben wird, bevor eine SSID im drahtlos gehosteten Netzwerk konfiguriert wird, schlägt die Funktion mit ERROR_BAD_CONFIGURATION fehl:

wlan_hosted_network_opcode_station_profile
wlan_hosted_network_opcode_connection_settings

Jeder Benutzer kann die WlanHostedNetworkQueryProperty-Funktion aufrufen, um die Eigenschaften des gehosteten Netzwerks abzufragen.

Unter Windows 7 und höher installiert das Betriebssystem ein virtuelles Gerät, wenn auf dem Computer ein gehosteter netzwerkfähiger Drahtlosadapter vorhanden ist. Dieses virtuelle Gerät wird normalerweise im "Netzwerkordner Connections" als "Drahtlose Netzwerkverbindung 2" mit dem Gerätenamen "Microsoft Virtual WiFi Miniport-Adapter" angezeigt, wenn der Computer über einen einzelnen drahtlosen Netzwerkadapter verfügt. Dieses virtuelle Gerät wird ausschließlich zum Ausführen von SoftAP-Verbindungen (Software Access Point) verwendet und ist nicht in der Liste enthalten, die von der WlanEnumInterfaces-Funktion zurückgegeben wird. Die Lebensdauer dieses virtuellen Geräts ist an den physischen Drahtlosadapter gebunden. Wenn der physische Drahtlosadapter deaktiviert ist, wird auch dieses virtuelle Gerät entfernt. Dieses Feature ist auch unter Windows Server 2008 R2 verfügbar, wobei der Wireless LAN-Dienst installiert ist.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 7 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 R2 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	wlanapi.h (einschließlich Wlanapi.h)
Bibliothek	Wlanapi.lib
DLL	Wlanapi.dll