WiFi Framework C++ Edition
Public Member Functions | Protected Member Functions | List of all members
CwclMobileHotspot Class Reference

The class allows to control Mobile HotSpot feature on Windows 10 platform. More...

#include <wclWiFi.h>

Public Member Functions

 CwclMobileHotspot ()
 Creates a Mobile HotSpot component.
 
virtual ~CwclMobileHotspot ()
 Frees the component.
 
int Close ()
 Closes the Mobile HotSpot API and uninitializes the component.
 
int Open ()
 Opens the Mobile HotSpot API and initializes the component.
 
int Start ()
 Starts the Mobile HotSpot.
 
int Stop ()
 Stops the Mobile HotSpot.
 
int GetState (wclMobileHotspotState &State) const
 Gets the current Mobile HotSpot state.
 
int GetSsid (tstring &Ssid) const
 Gets the AP SSID.
 
int SetSsid (const tstring &Ssid)
 Sets the AP SSID.
 
int GetPassphrase (tstring &Passphrase) const
 Gets the AP passphrase.
 
int SetPassphrase (const tstring &Passphrase)
 Sets the AP passphrase.
 
int IsBandSupported (const wclMobileHotspotBand Band, bool &Supported) const
 Checks whether the WiFi Mobile HotSpot supports the specified wireless frequency band.
 
int GetBand (wclMobileHotspotBand &Band) const
 Gets the wireless frequency band of the WiFi Mobile HotSpot.
 
int SetBand (const wclMobileHotspotBand Band)
 Sets the wireless frequency band of the WiFi Mobile HotSpot. Use IsBandSupported to check whether the WiFi adapter allows configuring a specific frequency band.
 
int GetMaxClientCount (unsigned long &Count) const
 Gets the maximum number of client connections over a Mobile HotSpot.
 
int GetClientCount (unsigned long &Count) const
 Gets the current number of connected clients on the Mobile HotSpot.
 
int GetClients (wclMobileHotspotClients &Clients) const
 Gets the list of connected clients.
 
int IsNoConnectionsTimeoutEnabled (bool &Enabled)
 Gets a value indicating whether the NoConnections timeout is enabled. If enabled, Mobile HotSpot turns off automatically in 5 minutes after the last peer of the tethering connection goes away.
 
int DisableNoConnectionsTimeout ()
 Disables the NoConnections timeout.
 
int EnableNoConnectionsTimeout ()
 Enables the NoConnections timeout. This means that Mobile HotSpot turns off automatically in 5 minutes after the last peer of the tethering connection goes away.
 
bool GetActive () const
 Gets the Mobile HotSpot component state.
 
 __declspec (property(get=GetActive)) bool Active
 Gets the Mobile HotSpot component state.
 
__event void OnClosed (void *Sender)
 The event fires when the Mobile HotSpot has been closed.
 
__event void OnOpened (void *Sender)
 The event fires when the Mobile HotSpot has been opened.
 

Protected Member Functions

virtual void DoClosed ()
 Fires the OnClosed event.
 
virtual void DoOpened ()
 Fires the OnOpened event.
 

Detailed Description

The class allows to control Mobile HotSpot feature on Windows 10 platform.