HSPluginInitPlugin function

The HSPluginInitPlugin function is exported by the plugin DLL and is called to initialize the plugin.

Syntax

DWORD HSPluginInitPlugin(
  _In_  HANDLE                hPluginContext,
  _In_  DWORD                 dwVerNumUsed,
  _In_  DWORD                 dwHostCapabilities,
  _In_  HS_DEVICE_IDENTITY    *pDeviceIdentity,
  _In_  HOTSPOT_HOST_HANDLERS *pHotspotHostHandlers,
  _Out_ HOTSPOT_PLUGIN_APIS   *pHotspotPluginAPIs,
  _Out_ HS_PLUGIN_PROFILE     *pPluginProfile
);

Parameters

  • hPluginContext [in]
    A handle, provided by the host, that the plugin is required to save and then use when it needs to make a request to the host by way of the host handler functions.

  • dwVerNumUsed [in]
    The host's current version number.

  • dwHostCapabilities [in]
    Value that specifies the list of capabilities that the host can provide to the plugin. This value is the bitwise OR combination of the applicable capability flags. For more information about capability flags, see the HS_FLAG_CAPABILITY_* constants in Wi-Fi Hotspot Offloading Constants.

    Note  If the host does not supply all the capabilities required by the plugin, the plugin will not be initialized.

     

  • *pDeviceIdentity [in]
    Pointer to a HS_DEVICE_IDENTITY structure that contains information about the device manufacturer and model.

  • *pHotspotHostHandlers [in]
    Pointer to a HOTSPOT_HOST_HANDLERS structure that contains the hotspot host handlers function table. This table contains pointers to functions that are called by the plugin to communicate with the hotspot host.

  • *pHotspotPluginAPIs [out]
    Pointer to the HOTSPOT_PLUGIN_APIS structure that contains the hotspot plugin APIs function table. This table is returned by the plugin and contains pointers to functions that are called by the host to communicate with the plugin.

  • *pPluginProfile [out]
    Pointer to a HS_PLUGIN_PROFILE structure, returned by the plugin, that provides information about the plugin.

Remarks

During initialization, the host provides the following:

  • The plugin context handle
  • The current version number
  • A list of capabilities that the host can provide to the plugin
  • A pointer to the host handler function table through which the plugin can communicate with the host

The plugin returns a pointer to its own function table and a pointer to its HS_PLUGIN_PROFILE structure.

Requirements

Version

Windows 10 Mobile

Header

Hotspotoffloadplugin.h (include Hotspotoffloadplugin.h)

See also

Wi-Fi Hotspot Offloading Constants

HS_DEVICE_IDENTITY

HOTSPOT_HOST_HANDLERS

HOTSPOT_PLUGIN_APIS

HS_PLUGIN_PROFILE

 

 

Send comments about this topic to Microsoft