HS_PLUGIN_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_PLUGIN_PROFILE structure provides information about the plugin. The members of this structure are set by the plugin during execution of the HSPluginInitPlugin function that is called by the host.

Syntax

typedef struct _HS_PLUGIN_PROFILE {
  DWORD dwPluginCapabilities;
  DWORD dwNumNetworksSupported;
  DWORD dwProviderNameStringID;
  DWORD dwGenericNetworkNameStringID;
  DWORD dwAdvancedPageStringID;
  DWORD dwProfileUpdateTimeDays;
  WCHAR szRealm[HS_CONST_MAX_REALM_LENGTH+1];
  DWORD dwSupportedSIMCount;
} HS_PLUGIN_PROFILE, *PHS_PLUGIN_PROFILE;

Members

dwPluginCapabilities
Required.

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

dwNumNetworksSupported
Required.

Total number of networks supported by this plugin.

dwProviderNameStringID
Required.

The network provider name which is displayed to the user. Maximum string size = MAX_PROVIDER_NAME_LENGTH.

dwGenericNetworkNameStringID
Optional.

Network name. Maximum string size = MAX_NETWORK_DISPLAY_NAME_LENGTH.

dwAdvancedPageStringID
Optional.

Maximum string size = HS_CONST_MAX_ADVANCED_PAGE_STRING_LENGTH.

dwProfileUpdateTimeDays
Optional.

Must be greater than or equal to HS_CONST_MIN_PROFILE_UPDATE_TIME_IN_DAYS.

szRealm
Required if HS_FLAG_CAPABILITIES_NETWORK_CUSTOM_REALM is set.

Network-specific realm value.

dwSupportedSIMCount
The size of the list pointed to by pSupported SIMs.

Requirements

Header

Hotspotoffloadplugin.h (include Hotspotoffloadplugin.h)

See also

HSPluginInitPlugin

Wi-Fi Hotspot Offloading Constants