HS_NETWORK_PROFILE 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 HS_NETWORK_PROFILE structure is provided by the plugin and contains information required for connection to the target network. Each instance of the Network Profile is uniquely associated with a corresponding HS_NETWORK_IDENTITY structure.

Syntax

typedef struct _HS_NETWORK_PROFILE {
  DWORD  dwNetworkCapabilities;
  USHORT usPriority;
  DWORD  dwSupportedSIMCount;
  DWORD  dmNumCellularExceptions;
  DWORD  dwNetworkStringID;
  DWORD  dwKeepAliveTimeMins;
  WCHAR  szRealm[HS_CONST_MAX_REALM_LENGTH+1];
} HS_NETWORK_PROFILE, *PHS_NETWORK_PROFILE;

Members

dwNetworkCapabilities
A subset of the possible HS_FLAG_CAPABILITY_NETWORK_\* values. For more information about hotspot host capabilities, see Wi-Fi Hotspot Offloading Constants.

usPriority
A unique priority value assigned to the associated network. It must be a value between 1 and 65000 (a hidden network must have a value of 1). A lower numeric value corresponds to a higher priority.

dwSupportedSIMCount
Supported SIM count. This member is set for HTTP-based and EAP-SIM/AKA/AKA' authentication.

dmNumCellularExceptions
Optional. Number of host connections over cellular only.

dwNetworkStringID
Network name string ID. Maximum string size = MAX_NETWORK_DISPLAY_NAME_LENGTH.

dwKeepAliveTimeMins
Optional. The time interval between network connection keep-alive messages.

szRealm
Network-specific realm value.

Requirements

Header

Hotspotoffloadplugin.h (include Hotspotoffloadplugin.h)

See also

HS_NETWORK_IDENTITY

Wi-Fi Hotspot Offloading Constants