Función WlanHostedNetworkQueryProperty (wlanapi.h)

Artículo
03/15/2023

La función WlanHostedNetworkQueryProperty consulta las propiedades estáticas actuales de la red hospedada inalámbrica.

Sintaxis

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
);

Parámetros

[in] hClientHandle

Identificador de sesión del cliente, devuelto por una llamada anterior a la función WlanOpenHandle .

[in] OpCode

Identificador de la propiedad que se va a consultar. Este identificador puede ser cualquiera de los valores de la enumeración WLAN_HOSTED_NETWORK_OPCODE definida en el archivo de encabezado Wlanapi.h .

[out] pdwDataSize

Puntero a un valor que especifica el tamaño, en bytes, del búfer devuelto en el parámetro ppvData , si la llamada a la función WlanHostedNetworkQueryProperty se realiza correctamente.

[out] ppvData

En la entrada, este parámetro debe ser NULL.

En la salida, este parámetro recibe un puntero a un búfer devuelto con la propiedad estática solicitada, si la llamada a la función WlanHostedNetworkQueryProperty se realiza correctamente. El tipo de datos asociado a este búfer depende del valor del parámetro OpCode .

[out] pWlanOpcodeValueType

Puntero a un valor que recibe el tipo de valor de la propiedad wireless Hosted Network, si la llamada a la función WlanHostedNetworkQueryProperty se realiza correctamente. El valor devuelto es un tipo enumerado en la enumeración WLAN_OPCODE_VALUE_TYPE definida en el archivo de encabezado Wlanapi.h .

pvReserved

Reservado para uso futuro. Este parámetro debe ser NULL.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es ERROR_SUCCESS.

Si se produce un error en la función, el valor devuelto puede ser uno de los siguientes códigos de retorno.

Código devuelto	Descripción
ERROR_BAD_CONFIGURATION	Los datos de configuración de la red hospedada inalámbrica no están configurados. Este error se devuelve si la aplicación llama a la función WlanHostedNetworkQueryProperty con el parámetro OpCode establecido en wlan_hosted_network_opcode_station_profile o wlan_hosted_network_opcode_connection_settings antes de configurar un SSID en la red hospedada inalámbrica.
ERROR_INVALID_HANDLE	Un identificador no es válido. Este error se devuelve si no se encontró el identificador especificado en el parámetro hClientHandle en la tabla de identificadores.
ERROR_INVALID_PARAMETER	Un parámetro es incorrecto. Este error se devuelve si se produce alguna de las condiciones siguientes: hClientHandle es NULL. OpCode no es uno de los valores enumerados definidos en el WLAN_HOSTED_NETWORK_OPCODE. pdwDataSize es NULL. ppvData es NULL. pWlanOpcodeValueType es NULL. pvReserved no es NULL.
ERROR_INVALID_STATE	El recurso no está en el estado correcto para realizar la operación solicitada. Esto puede ocurrir si la red hospedada inalámbrica estaba en proceso de apagado.
ERROR_OUTOFMEMORY	No hay suficiente almacenamiento disponible para completar esta operación.
ERROR_SERVICE_NOT_ACTIVE	El servicio no se ha iniciado. Este error se devuelve si el servicio WLAN AutoConfig no se está ejecutando.
Otros	Varios rpc y otros códigos de error. Use FormatMessage para obtener la cadena de mensaje del error devuelto.

Comentarios

La función WlanHostedNetworkQueryProperty es una extensión para las API inalámbricas nativas agregadas para admitir la red inalámbrica hospedada en Windows 7 y en Windows Server 2008 R2 con el servicio LAN inalámbrico instalado.

Una aplicación cliente llama a la función WlanHostedNetworkQueryProperty para consultar las propiedades estáticas actuales de la red hospedada inalámbrica. Esta función no cambia el estado ni las propiedades de la red hospedada inalámbrica.

Si la función se ejecuta correctamente, el parámetro ppvData apunta a un búfer que contiene la propiedad solicitada. El tamaño de este búfer se devuelve en un puntero devuelto en el parámetro pwdDataSize . El WLAN_OPCODE_VALUE_TYPE se devuelve en un puntero devuelto en el parámetro pWlanOpcodeValueType . La memoria usada para el búfer en el parámetro ppvData que se devuelve debe liberarse llamando a la función WlanFreeMemory después de que el búfer ya no sea necesario.

El tipo de datos asociado al búfer al que apunta el parámetro ppvData depende del valor del parámetro OpCode de la siguiente manera:

OpCode	Descripción
wlan_hosted_network_opcode_connection_settings	Se devuelve un puntero a una estructura WLAN_HOSTED_NETWORK_CONNECTION_SETTINGS .
wlan_hosted_network_opcode_security_settings	Se devuelve un puntero a una estructura WLAN_HOSTED_NETWORK_SECURITY_SETTINGS .
wlan_hosted_network_opcode_station_profile	Se devuelve un PWSTR que contiene un perfil WLAN XML para conectarse a la red hospedada inalámbrica.
wlan_hosted_network_opcode_enable	PBOOL que indica si se habilita la red hospedada inalámbrica.

Si la función WlanHostedNetworkQueryProperty pasa cualquiera de los siguientes valores en el parámetro OpCode antes de configurar un SSID en la red hospedada inalámbrica, se producirá un error en la función con ERROR_BAD_CONFIGURATION:

wlan_hosted_network_opcode_station_profile
wlan_hosted_network_opcode_connection_settings

Cualquier usuario puede llamar a la función WlanHostedNetworkQueryProperty para consultar las propiedades de la red hospedada.

En Windows 7 y versiones posteriores, el sistema operativo instala un dispositivo virtual si un adaptador inalámbrico compatible con red hospedada está presente en la máquina. Este dispositivo virtual aparece normalmente en la "Carpeta de red Connections" como "Conexión de red inalámbrica 2" con un nombre de dispositivo de "Adaptador de miniporte de Microsoft Virtual WiFi" si el equipo tiene un único adaptador de red inalámbrica. Este dispositivo virtual se usa exclusivamente para realizar conexiones de punto de acceso de software (SoftAP) y no está presente en la lista devuelta por la función WlanEnumInterfaces . La duración de este dispositivo virtual está vinculada al adaptador inalámbrico físico. Si el adaptador inalámbrico físico está deshabilitado, este dispositivo virtual también se quitará. Esta característica también está disponible en Windows Server 2008 R2 con el servicio LAN inalámbrico instalado.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 7 [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2008 R2 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	wlanapi.h (incluya Wlanapi.h)
Library	Wlanapi.lib
Archivo DLL	Wlanapi.dll