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

The CwclWiFiHostedNetwork component provides access to the WiFi Hosted Network features. More...

#include <wclWiFi.h>

Inheritance diagram for CwclWiFiHostedNetwork:
CwclCustomWiFiMemoryComponent CwclCustomWiFiSecurableComponent CwclCustomWiFiComponent

Public Member Functions

 CwclWiFiHostedNetwork ()
 Creates a new component.
 
int GetConnectionSettings (wclWiFiHostedNetworkConnectionSettings &Settings) const
 Reads the information about the connection settings on the wireless Hosted Network.
 
int GetKey (unsigned long &KeyLength, void *&KeyData, bool &IsPassPhrase, bool &Persistent) const
 Reads the secondary security key that is configured to be used by the wireless Hosted Network.
 
int GetLocalIp (tstring &Address) const
 Gets the local IP address for the Hosted Network Virtual WiFi adapter.
 
int GetConnectedPeers (wclWiFiHostedNetworkConnectedPeers &Peers)
 Gets the list of currently connected peers.
 
int GetProfile (tstring &ProfileXml) const
 Reads the wireless Hosted Network station profile.
 
int GetRemoteIp (const tstring &Mac, tstring &Address) const
 Gets the remote IP address for the device connected to Hosted Network Virtual WiFi adapter.
 
int GetSecuritySettings (wclWiFiAuthCipherPair &Settings) const
 Reads the information about the security settings on the wireless Hosted Network.
 
int GetStatus (wclWiFiHostedNetworkStatus &Status) const
 The function queries the current status of the wireless Hosted Network.
 
int GetState (bool &Enabled) const
 Reads the wireless Hosted Network enabled flag.
 
int SetConnectionSettings (const wclWiFiHostedNetworkConnectionSettings &Settings)
 Writes the information about the connection settings on the wireless Hosted Network.
 
int SetKey (const unsigned long KeyLength, const void *const KeyData, const bool IsPassPhrase, const bool Persistent)
 The method configures the secondary security key that will be used by the wireless Hosted Network.
 
int SetState (const bool Enabled)
 Writes the wireless Hosted Network enabled flag.
 
int RefreshSecuritySettings ()
 The function refreshes the configurable and auto-generated parts of the wireless Hosted Network security settings.
 
int Restart ()
 Restarts the Hosted Network service.
 
int SetPsdIe (const tstring &Format, const wclWiFiScanIeData &Data)
 Sets the proximity service discovery (PSD) information element (IE) data.
 
wclWiFiScanIeData GetData () const
 Gets the PSD IE data.
 
 __declspec (property(get=GetData)) wclWiFiScanIeData Data
 Gets the PSD IE data.
 
tstring GetFormat () const
 Gets the PSD IE format string.
 
 __declspec (property(get=GetFormat)) tstring Format
 Gets the PSD IE format string.
 
- Public Member Functions inherited from CwclCustomWiFiMemoryComponent
 CwclCustomWiFiMemoryComponent ()
 Creates new object.
 
int FreeMemory (const LPVOID Memory) const
 The method frees memory.
 
- Public Member Functions inherited from CwclCustomWiFiSecurableComponent
 CwclCustomWiFiSecurableComponent ()
 Creates new object.
 
- Public Member Functions inherited from CwclCustomWiFiComponent
 CwclCustomWiFiComponent ()
 Creates a new component.
 
virtual ~CwclCustomWiFiComponent ()
 Frees the component.
 
int Close ()
 Closes the component.
 
int Open ()
 Opens the component.
 
bool GetActive () const
 Gets the component state.
 
 __declspec (property(get=GetActive)) bool Active
 Gets the component state.
 
__event void AfterOpen (void *Sender)
 The event fires after the component was successfully opened.
 
__event void BeforeClose (void *Sender)
 The even fires before the component will be closed.
 

Protected Member Functions

virtual int InternalClose () override
 Executes additional finalization procedures.
 
virtual int InternalOpen () override
 Executes additional initialization procedures.
 
- Protected Member Functions inherited from CwclCustomWiFiSecurableComponent
virtual int ElevatePrivileges () const override
 The function sets up privileges for Native WiFi.
 
- Protected Member Functions inherited from CwclCustomWiFiComponent
virtual int ElevatePrivileges () const
 The function must setup privileges for Native WiFi.
 
virtual int InternalClose ()=0
 Executes additional finalization procedures.
 
virtual int InternalOpen ()=0
 Executes additional initialization procedures.
 
virtual void DoAfterOpen ()
 Fires the AfterOpen event.
 
virtual void DoBeforeClose ()
 Fires the BeforeClose event.
 
HANDLE GetHandle () const
 Provides access to the WLAN subsystem handle.
 
 __declspec (property(get=GetHandle)) HANDLE Handle
 Provides access to the WLAN subsystem handle.
 

Detailed Description

The CwclWiFiHostedNetwork component provides access to the WiFi Hosted Network features.

In order to receiver the Hosted Network notifications an application must use the CwclWiFiEvents component.