Edit

eHS_AUTHENTICATION_RESULT 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_AUTHENTICATION_RESULT enumeration indicates the result of authentication by the plugin after the PostConnectAuth request.

Syntax

typedef enum _eHS_AUTHENTICATION_RESULT { 
  HS_AUTHENTICATION_RESULT_SUCCESS         = 0,
  HS_AUTHENTICATION_RESULT_FAILED_TIMEOUT  = 100,
  HS_AUTHENTICATION_RESULT_FAILED_AUTH,
  HS_AUTHENTICATION_RESULT_FAILED_CONNECT,
  HS_AUTHENTICATION_RESULT_FAILED_OTHER,
  HS_AUTHENTICATION_RESULT_MAX
} eHS_AUTHENTICATION_RESULT;

Constants

HS_AUTHENTICATION_RESULT_SUCCESS
Indicates the authentication was successful.

HS_AUTHENTICATION_RESULT_FAILED_TIMEOUT
Indicates the authentication failed due to a timeout from the server/back end.

HS_AUTHENTICATION_RESULT_FAILED_AUTH
Indicates the authentication failed due to incorrect credentials.

HS_AUTHENTICATION_RESULT_FAILED_CONNECT
Indicates the authentication failed due to an inability to connect to the authentication server

HS_AUTHENTICATION_RESULT_FAILED_OTHER
Indicates the authentication failed for some other reason.

HS_AUTHENTICATION_RESULT_MAX
Indicates an out-of-range value.

Remarks

The plugin passes this enumeration value to the hotspot plugin host through the HS_HOST_POST_CONNECT_AUTH_COMPLETION function, which is used to inform the hotspot plugin host of the results of a call to HS_PLUGIN_START_POST_CONNECT_AUTH.

Requirements

Version

Windows 10 Mobile

Header

Hotspotoffloadplugin.h (include Hotspotoffloadplugin.h)