Edit

Share via


HS_PLUGIN_QUERY_HIDDEN_NETWORK function

Wi-Fi Hotspot Offloading deprecation note

Important

Starting in Windows 10, version 1709, the Wi-Fi Hotspot Offloading feature is deprecated and should not be used. Instead, we recommend writing a UWP app and using the Wi-Fi Hotspot Authentication API (Windows.Networking.NetworkOperators).

For a code sample and more info, see the Wi-Fi hotspot authentication sample.

The HS_PLUGIN_QUERY_HIDDEN_NETWORK function returns the network identity and network profile for a hidden network.

Syntax

 typedef DWORD (WINAPI *HS_PLUGIN_QUERY_HIDDEN_NETWORK)(
  _Out_ HS_NETWORK_IDENTITY *pHiddenNetworkIdentity,
  _Out_ HS_NETWORK_PROFILE  *pHiddenNetworkProfile
);

Parameters

*pHiddenNetworkIdentity [out]
The HS_NETWORK_IDENTITY structure that uniquely identifies the network.

*pHiddenNetworkProfile [out]
The HS_NETWORK_PROFILE structure that contains the network profile.

Return value

This function is called by the host to communicate with the plugin and does not return a value.

Remarks

The host calls this function only if the dwPluginCapabilities field of the associated plugin's HS_PLUGIN_PROFILE structure includes the HS_FLAG_CAPABILITY_NETWORK_TYPE_HIDDEN capability.

The plugin must provide both the network identity and the network profile for the hidden Wi-Fi network.

This network must have the highest priority (1) among all the hotspot networks.

The hotspot offload service imposes a limitation of one hidden network for the life of the service. Therefore, in the case where there are multiple plugins installed, only the first plugin's request to specify a hidden network will be accepted.

Requirements

Version

Windows 10 Mobile

Header

Hotspotoffloadplugin.h (include Hotspotoffloadplugin.h)

See also

HS_NETWORK_IDENTITY

HS_NETWORK_PROFILE

HS_PLUGIN_PROFILE