Edit

eHS_UNLOAD_REASON enumeration

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 eHS_UNLOAD_REASON enumeration indicates the reason for the plugin to get unloaded.

Syntax

typedef enum _eHS_UNLOAD_REASON { 
  HS_UNLOAD_REASON_NONE,
  HS_UNLOAD_REASON_PLUGN_INIT_FAILED,
  HS_UNLOAD_REASON_NO_NETWORKS_SUPPORTED,
  HS_UNLOAD_REASON_NO_PROVIDE_NAME_ID,
  HS_UNLOAD_REASON_ZERO_SIM_COUNT,
  HS_UNLOAD_REASON_DISPLAY_FLAG_BUT_NO_DISPLAY_STRING_ID,
  HS_UNLOAD_REASON_CUSTOM_REALM_FLAG_BUT_NO_REALM_STRING,
  HS_UNLOAD_REASON_DUPLICATE_PLUGIN_LOADED,
  HS_UNLOAD_REASON_RELOAD_REQUESTED_BY_PLUGIN,
  HS_UNLOAD_REASON_EXCEPTION_DURING_PLUGIN_CALL,
  HS_UNLOAD_REASON_EXCEPTION_IN_PLUGIN_HOST,
  HS_UNLOAD_REASON_ASYNC_INITIALIZATION_FAILED,
  HS_UNLOAD_REASON_UNSUPPORTED_AUTH_CAPABILITY_REQUESTED,
  HS_UNLOAD_REASON_FAILED_TO_LOAD_PROVIDER_NAME_STRING,
  HS_UNLOAD_REASON_FAILED_TO_LOAD_ADVANCED_PAGE_STRING,
  HS_UNLOAD_REASON_FAILED_TO_LOAD_NETWORK_NAME_STRING,
  HS_UNLOAD_REASON_FAILED_TO_CONFIGURE_HIDDEN_NETWORK,
  HS_UNLOAD_REASON_HIDDEN_NETWORK_ALREADY_CONFIGURED,
  HS_UNLOAD_REASON_FAILED_TO_QUERY_SIMS,
  HS_UNLOAD_REASON_PLUGIN_REQUIRED_SIM_NOT_PRESENT,
  HS_UNLOAD_REASON_SIM_CONFIG_CHANGED,
  HS_UNLOAD_REASON_WIFI_SWITCHED_OFF_IN_OS,
  HS_UNLOAD_REASON_MAX
} eHS_UNLOAD_REASON;

Constants

HS_UNLOAD_REASON_NONE
No specific reason for the unload operation.

HS_UNLOAD_REASON_PLUGN_INIT_FAILED
The plugin is being unloaded because it failed to initialize successfully.

HS_UNLOAD_REASON_NO_NETWORKS_SUPPORTED
The plugin is being unloaded because the plugin's HS_PLUGIN_PROFILE structure did not indicate a valid value for dwNumNetworksSupported.

HS_UNLOAD_REASON_NO_PROVIDE_NAME_ID
The plugin is being unloaded because the plugin's HS_PLUGIN_PROFILE structure did not specify a string ID for dwProviderNameStringID.

HS_UNLOAD_REASON_ZERO_SIM_COUNT
The plugin is being unloaded because there are no SIM cards present.

HS_UNLOAD_REASON_DISPLAY_FLAG_BUT_NO_DISPLAY_STRING_ID
The plugin is being unloaded because the plugin's HS_PLUGIN_PROFILE structure requires HTTP or EAP SIM-based authentication but did not specify a value for dwSupportedSIMCount.

HS_UNLOAD_REASON_CUSTOM_REALM_FLAG_BUT_NO_REALM_STRING
The plugin is being unloaded because the plugin's HS_PLUGIN_PROFILE structure specified the HS_FLAG_CAPABILITY_NETWORK_CUSTOM_REALM capability but did not provide a valid string for szRealm.

HS_UNLOAD_REASON_DUPLICATE_PLUGIN_LOADED
The plugin is being unloaded because another plugin is using the same DLL.

HS_UNLOAD_REASON_RELOAD_REQUESTED_BY_PLUGIN
The plugin is being unloaded because the plugin requested to be unloaded and reloaded by specifying the HS_UPDATE_RESULT_ACTION_RELOAD action with the eHS_UPDATE_RESULT enumeration.

HS_UNLOAD_REASON_EXCEPTION_DURING_PLUGIN_CALL
The plugin is being unloaded because the host process encountered an exception while in a call to the plugin.

HS_UNLOAD_REASON_EXCEPTION_IN_PLUGIN_HOST
The plugin is being unloaded because the hotspot host encountered an exception.

HS_UNLOAD_REASON_ASYNC_INITIALIZATION_FAILED
The plugin is being unloaded because the hotspot service failed to register for notifications from the plugin.

HS_UNLOAD_REASON_UNSUPPORTED_AUTH_CAPABILITY_REQUESTED
The plugin is being unloaded because none of the authentication capabilities requested by the plugin are available.

HS_UNLOAD_REASON_FAILED_TO_LOAD_PROVIDER_NAME_STRING
The plugin is being unloaded because the hotspot service could not map the dwProviderNameStringID string ID provided in the plugin's HS_PLUGIN_PROFILE structure to a valid string.

HS_UNLOAD_REASON_FAILED_TO_LOAD_ADVANCED_PAGE_STRING
The plugin is being unloaded because the plugin's HS_PLUGIN_PROFILE structure specified an (optional) dwAdvancedPageStringID string ID but it did not map to a valid string.

HS_UNLOAD_REASON_FAILED_TO_LOAD_NETWORK_NAME_STRING
The plugin is being unloaded because the plugin's HS_PLUGIN_PROFILE structure specified an (optional) dwGenericNetworkNameStringID string ID, but it did not map to a valid string.

HS_UNLOAD_REASON_FAILED_TO_CONFIGURE_HIDDEN_NETWORK
The plugin is being unloaded because the plugin specified a hidden network (via the HS_FLAG_CAPABILITY_NETWORK_TYPE_HIDDEN capability), but the hotspot service was unable to configure the hidden network.

HS_UNLOAD_REASON_HIDDEN_NETWORK_ALREADY_CONFIGURED
The plugin is being unloaded because the plugin specified a hidden network via the HS_FLAG_CAPABILITY_NETWORK_TYPE_HIDDEN capability but another plugin has already claimed the hidden network slot.

HS_UNLOAD_REASON_FAILED_TO_QUERY_SIMS
The plugin is being unloaded because the call to HS_PLUGIN_QUERY_SUPPORTED_SIMS failed.

HS_UNLOAD_REASON_PLUGIN_REQUIRED_SIM_NOT_PRESENT
The plugin is being unloaded because the SIMs required by the plugin are not present in the device.

HS_UNLOAD_REASON_SIM_CONFIG_CHANGED
The plugin is being unloaded because the SIM configuration changed, which requires the plugins to be unloaded and reloaded.

HS_UNLOAD_REASON_WIFI_SWITCHED_OFF_IN_OS
The plugin is being unloaded because Wi-Fi functionality was switched off in the OS.

HS_UNLOAD_REASON_MAX
Indicates an out-of-range value.

Requirements

Version

Windows 10 Mobile

Header

 Hotspotoffloadplugin.h (include Hotspotoffloadplugin.h)

See also

HS_PLUGIN_PROFILE

eHS_UPDATE_RESULT

HS_PLUGIN_QUERY_SUPPORTED_SIMS

  • Last updated on