Функция WlanHostedNetworkQueryProperty (wlanapi.h)

Статья
08/28/2023

Функция WlanHostedNetworkQueryProperty запрашивает текущие статические свойства беспроводной размещенной сети.

Синтаксис

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

Параметры

[in] hClientHandle

Дескриптор сеанса клиента, возвращенный предыдущим вызовом функции WlanOpenHandle .

[in] OpCode

Идентификатор запрашиваемого свойства. Этот идентификатор может быть любым из значений перечисления WLAN_HOSTED_NETWORK_OPCODE , определенного в файле заголовка Wlanapi.h .

[out] pdwDataSize

Указатель на значение, указывающее размер (в байтах) буфера, возвращаемого в параметре ppvData , если вызов функции WlanHostedNetworkQueryProperty выполнен успешно.

[out] ppvData

При входе этот параметр должен иметь значение NULL.

В выходных данных этот параметр получает указатель на буфер, возвращаемый с запрошенным статическим свойством, если вызов функции WlanHostedNetworkQueryProperty выполнен успешно. Тип данных, связанный с этим буфером, зависит от значения параметра OpCode .

[out] pWlanOpcodeValueType

Указатель на значение, которое получает тип значения свойства беспроводной размещенной сети, если вызов функции WlanHostedNetworkQueryProperty выполнен успешно. Возвращаемое значение является перечислимым типом в перечислении WLAN_OPCODE_VALUE_TYPE , определенном в файле заголовка Wlanapi.h .

pvReserved

Зарезервировано для последующего использования. Этот параметр должен иметь значение NULL.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение будет ERROR_SUCCESS.

Если функция завершается сбоем, возвращаемое значение может быть одним из следующих кодов возврата.

Код возврата	Описание
ERROR_BAD_CONFIGURATION	Данные конфигурации для беспроводной размещенной сети не настроены. Эта ошибка возвращается, если приложение вызывает функцию WlanHostedNetworkQueryProperty с параметром OpCodewlan_hosted_network_opcode_station_profile илиwlan_hosted_network_opcode_connection_settings до настройки SSID в беспроводной размещенной сети.
ERROR_INVALID_HANDLE	Недопустимый дескриптор. Эта ошибка возвращается, если дескриптор, указанный в параметре hClientHandle , не найден в таблице дескрипторов.
ERROR_INVALID_PARAMETER	Неправильный параметр. Эта ошибка возвращается при возникновении какого-либо из следующих условий: hClientHandle имеет значение NULL. OpCode не является одним из перечисленных значений, определенных в WLAN_HOSTED_NETWORK_OPCODE. pdwDataSize имеет значение NULL. ppvData имеет значение NULL. pWlanOpcodeValueType имеет значение NULL. pvReserved не имеет значения NULL.
ERROR_INVALID_STATE	Ресурс не находится в правильном состоянии для выполнения запрошенной операции. Это может произойти, если беспроводная размещенная сеть была в процессе завершения работы.
ERROR_OUTOFMEMORY	Недостаточно места в хранилище для завершения этой операции.
ERROR_SERVICE_NOT_ACTIVE	Служба не запущена. Эта ошибка возвращается, если служба автонастройки WLAN не запущена.
Другое	Различные коды RPC и другие коды ошибок. Используйте FormatMessage , чтобы получить строку сообщения для возвращаемой ошибки.

Функция WlanHostedNetworkQueryProperty — это расширение собственных беспроводных API, добавленных для поддержки беспроводной размещенной сети в Windows 7 и Windows Server 2008 R2 с установленной службой беспроводной локальной сети.

Клиентское приложение вызывает функцию WlanHostedNetworkQueryProperty для запроса текущих статических свойств беспроводной размещенной сети. Эта функция не изменяет состояние или свойства беспроводной размещенной сети.

Если функция выполняется успешно, параметр ppvData указывает на буфер, содержащий запрошенное свойство. Размер этого буфера возвращается в указателе, возвращаемом параметром pwdDataSize . WLAN_OPCODE_VALUE_TYPE возвращается в указателе, возвращаемом в параметре pWlanOpcodeValueType. Память, используемая для буфера в возвращаемом параметре ppvData , должна быть освобождена путем вызова функции WlanFreeMemory после того, как буфер больше не нужен.

Тип данных, связанный с буфером, на который указывает параметр ppvData , зависит от значения параметра OpCode следующим образом:

OpCode	Описание
wlan_hosted_network_opcode_connection_settings	Возвращается указатель на структуру WLAN_HOSTED_NETWORK_CONNECTION_SETTINGS .
wlan_hosted_network_opcode_security_settings	Возвращается указатель на структуру WLAN_HOSTED_NETWORK_SECURITY_SETTINGS .
wlan_hosted_network_opcode_station_profile	Возвращается значение PWSTR , содержащее профиль WLAN XML для подключения к беспроводной размещенной сети.
wlan_hosted_network_opcode_enable	Возвращается значение PBOOL , указывающее, включена ли беспроводная размещенная сеть.

Если функция WlanHostedNetworkQueryProperty передает любое из следующих значений в параметре OpCode до настройки SSID в беспроводной размещенной сети, функция завершится сбоем с ERROR_BAD_CONFIGURATION:

wlan_hosted_network_opcode_station_profile
wlan_hosted_network_opcode_connection_settings

Любой пользователь может вызвать функцию WlanHostedNetworkQueryProperty для запроса свойств размещенной сети.

В Windows 7 и более поздних версиях операционная система устанавливает виртуальное устройство, если на компьютере присутствует беспроводной адаптер с поддержкой размещенной сети. Это виртуальное устройство обычно отображается в папке "Сетевой Connections" как "Беспроводное сетевое подключение 2" с именем устройства "Microsoft Virtual WiFi Miniport adapter", если компьютер имеет один беспроводной сетевой адаптер. Это виртуальное устройство используется исключительно для выполнения подключений к точкам доступа программного обеспечения (SoftAP) и отсутствует в списке, возвращаемом функцией WlanEnumInterfaces . Время существования этого виртуального устройства привязано к физическому беспроводному адаптеру. Если физический беспроводной адаптер отключен, это виртуальное устройство также будет удалено. Эта функция также доступна в Windows Server 2008 R2 с установленной службой беспроводной локальной сети.

Требования

Требование	Значение
Минимальная версия клиента	Windows 7 [только классические приложения]
Минимальная версия сервера	Windows Server 2008 R2 [только классические приложения]
Целевая платформа	Windows
Header	wlanapi.h (включая Wlanapi.h)
Библиотека	Wlanapi.lib
DLL	Wlanapi.dll