Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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 HOTSPOT_PLUGIN_APIS structure contains the Hotspot plugin APIs function table. This function table is returned by the plugin when HSPluginInitPlugin is called to initialize the plugin. The table contains functions that are called by the hotspot host to communicate with the plugin.
Syntax
typedef struct _HOTSPOT_PLUGIN_APIS {
HS_PLUGIN_QUERY_SUPPORTED_SIMS HSPluginQuerySupportedSIMs;
HS_PLUGIN_QUERY_HIDDEN_NETWORK HSPluginQueryCellularExceptionHosts;
HS_PLUGIN_IS_HOTSPOT_NETWORK HSPluginIsHotspotNetwork;
HS_PLUGIN_PRE_CONNECT_INIT HSPluginPreConnectInit;
HS_PLUGIN_START_POST_CONNECT_AUTH HSPluginStartPostConnectAuth;
HS_PLUGIN_STOP_POST_CONNECT_AUTH HSPluginStopPostConnectAuth;
HS_PLUGIN_DISCONNECT_FROM_NETWORK HSPluginDisconnectFromNetwork;
HS_PLUGIN_RESET HSPluginReset;
HS_PLUGIN_SEND_KEEP_ALIVE HSPluginSendKeepAlive;
HS_PLUGIN_CHECK_FOR_UPDATES HSPluginCheckForUpdates;
HS_PLUGIN_DEINIT HSPluginDeinit;
} HOTSPOT_PLUGIN_APIS, *PHOTSPOT_PLUGIN_APIS;
Members
HSPluginQuerySupportedSIMs
API called during plugin initialization.
Called by the hotspot host to retrieve the list of SIMs that the plugin supports. It can be called to retrieve the complete list of supported SIMs, or just the SIMs for a specific network. For more information, see HS_PLUGIN_QUERY_SUPPORTED_SIMS.
HSPluginQueryCellularExceptionHosts
API called during plugin initialization.
Called by the hotspot host if the plugin has specified the HS_FLAG_CAPABILITY_NETWORK_TYPE_HIDDEN capability by way of the HS_PLUGIN_PROFILE structure. For more information, see HS_PLUGIN_QUERY_HIDDEN_NETWORK.
HSPluginIsHotspotNetwork
API called while processing scan results.
Called by the hotspot host to request the plugin to identify if the network passed in the pHiddenNetworkIdentity parameter is a hotspot network. For more information, see HS_PLUGIN_IS_HOTSPOT_NETWORK.
HSPluginPreConnectInit
Connection-process API.
Called by the hotspot host to notify the plugin to initialize its state when a connection is in progress. For more information, see HS_PLUGIN_PRE_CONNECT_INIT.
HSPluginStartPostConnectAuth
Connection-process API.
Called by the hotspot host to request the plugin to perform any post-connect authentication required to authenticate the device over the network. For more information, see HS_PLUGIN_START_POST_CONNECT_AUTH.
HSPluginStopPostConnectAuth
Connection-process API.
Called by the hotspot host to notify the plugin to stop the authentication process. For more information, see HS_PLUGIN_STOP_POST_CONNECT_AUTH.
HSPluginDisconnectFromNetwork
Connection-process API.
Called by the hotspot host to notify the plugin of disconnection from network. For more information, see HS_PLUGIN_DISCONNECT_FROM_NETWORK.
HSPluginReset
API to reset the plugin. If the plugin does not release any pending calls before returning from this call, the plugin will be unloaded.
Called by the hotspot host to reset the plugin. For more information, see HS_PLUGIN_RESET.
HSPluginSendKeepAlive
API for plugin to do periodic updates.
Called by the hotspot host to send a keep-alive message to the plugin. For more information, see HS_PLUGIN_SEND_KEEP_ALIVE.
HSPluginCheckForUpdates
API for plugin to do periodic updates.
Called by the hotspot host to check for updates. For more information, see HS_PLUGIN_CHECK_FOR_UPDATES.
HSPluginDeinit
API called to de-initialize and clean up the plugin before unloading.
Called by the hotspot host to notify the plugin that it is about to be unloaded. For more information, see HS_PLUGIN_DEINIT.
Requirements
Header |
Hotspotoffloadplugin.h (include Hotspotoffloadplugin.h) |
See also
HS_PLUGIN_QUERY_SUPPORTED_SIMS
HS_PLUGIN_QUERY_HIDDEN_NETWORK
HS_PLUGIN_START_POST_CONNECT_AUTH
HS_PLUGIN_STOP_POST_CONNECT_AUTH