Edit

Share via


HOTSPOT_HOST_HANDLERS structure

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_HOST_HANDLERS structure contains the hotspot host handlers function table. This function table is passed to the plugin when HSPluginInitPlugin is called to initialize it. The table contains functions that are called by the plugin to communicate with the hotspot host.

Syntax

typedef struct _HOTSPOT_HOST_HANDLERS {
  HS_HOST_ALLOCATE_MEMORY                          HSHostAllocateMemory;
  HS_HOST_FREE_MEMORY                              HSHostFreeMemory;
  HS_HOST_POST_CONNECT_AUTH_COMPLETION             HSHostPostConnectAuthCompletion;
  HS_HOST_SEND_KEEP_ALIVE_COMPLETION               HSHostSendKeepAliveCompletion;
  HS_HOST_UPDATE_CONFIGURATION_COMPLETION          HSHostUpdateConfigurationCompletion;
  HS_HOST_SEND_USER_MESSAGE                        HSHostSendUserMessage;
} HOTSPOT_HOST_HANDLERS, *PHOTSPOT_HOST_HANDLERS;

Members

HSHostAllocateMemory
Optional memory management handler.

Handle to the function that is called by the plugin to allocate any memory needed by the plugin. For more information, see HS_HOST_ALLOCATE_MEMORY.

HSHostFreeMemory
Optional memory management handler.

Handle to the function that is called by the plugin to free any memory that had been allocated earlier by the call to HS_HOST_ALLOCATE_MEMORY. For more information, see HS_HOST_FREE_MEMORY.

HSHostPostConnectAuthCompletion
Required connection-process handler.

Handle to the function that is called by the plugin to indicate the success or failure status resulting from the authentication attempt following a Wi-Fi connection setup at layer 2. For more information, see HS_PLUGIN_START_POST_CONNECT_AUTH.

HSHostSendKeepAliveCompletion
Optional periodic request.

Handle to the function that is called by the plugin to indicate the success or failure status resulting from the Send Keep Alive request. For more information, see HS_PLUGIN_SEND_KEEP_ALIVE.

HSHostUpdateConfigurationCompletion
Optional periodic request.

Handle to the function that is called by the plugin to indicate the success or failure of a call to check for updates. For more information, see HS_PLUGIN_CHECK_FOR_UPDATES.

HSHostSendUserMessage
Optional periodic request.

Handle to the function that is called to communicate with the user. For more information see HS_HOST_SEND_USER_MESSAGE.

Requirements

Header

Hotspotoffloadplugin.h (include Hotspotoffloadplugin.h)

See also

HSPluginInitPlugin

HS_HOST_ALLOCATE_MEMORY

HS_HOST_FREE_MEMORY

HS_PLUGIN_START_POST_CONNECT_AUTH

HS_PLUGIN_SEND_KEEP_ALIVE

HS_PLUGIN_CHECK_FOR_UPDATES

HS_HOST_SEND_USER_MESSAGE