HS_PLUGIN_QUERY_HIDDEN_NETWORK function

[!includeWi-Fi Hotspot Offloading deprecation]

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

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

See also

HS_NETWORK_IDENTITY

HS_NETWORK_PROFILE

HS_PLUGIN_PROFILE