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

Provides access to the Wireless Network profiles. More...

#include <wclWiFi.h>

Inheritance diagram for CwclWiFiProfilesManager:
CwclCustomWiFiMemoryComponent CwclCustomWiFiSecurableComponent CwclCustomWiFiComponent

Public Member Functions

 CwclWiFiProfilesManager ()
 Creates new object.
 
int GetProfile (const GUID &IfaceId, const tstring &ProfileName, wclWiFiProfileFlags &Flags, tstring &ProfileXml) const
 The method retrieves all information about a specified wireless profile.
 
int GetProfileList (const GUID &IfaceId, wclWiFiProfiles &Profiles) const
 The method retrieves the list of profiles in preference order.
 
int DeleteProfile (const GUID &IfaceId, const tstring &ProfileName)
 The method deletes a wireless profile for a wireless interface on the local computer.
 
int RenameProfile (const GUID &IfaceId, const tstring &OldName, const tstring &NewName)
 Renames the specified profile.
 
int SaveTemporaryProfile (const GUID &IfaceId, const tstring &ProfileName, const bool OverWrite, const wclWiFiTemporaryProfileFlags &Flags)
 Saves a temporary profile to the profile store.
 
int SetPosition (const GUID &IfaceId, const tstring &ProfileName, const unsigned long Position)
 The method sets the position of a single, specified profile in the preference list.
 
int SetProfile (const GUID &IfaceId, const wclWiFiProfileFlags &Flags, const tstring &ProfileXml, const bool Overwrite)
 The method sets the content of a specific profile.
 
int SetProfileList (const GUID &IfaceId, const std::vector< tstring > &Names)
 The method sets the preference order of profiles for a given interface.
 
int GetProfileUserData (const GUID &IfaceId, const tstring &ProfileName, unsigned long &DataSize, void *&Data) const
 The method gets the custom user data associated with a wireless profile.
 
int SetProfileUserData (const GUID &IfaceId, const tstring &ProfileName, const unsigned long DataSize, const void *const Data)
 Sets the custom user data associated with a profile.
 
int SetProfileEapXmlUserData (const GUID &IfaceId, const tstring &ProfileName, const bool AllUsers, const tstring &UserData)
 The method sets the Extensible Authentication Protocol (EAP) user credentials as specified by an XML string. The user credentials apply to a profile on an adapter (interface). These credentials can only be used by the caller.
 
int SetProfileEapUserData (const GUID &IfaceId, const tstring &ProfileName, const bool AllUsers, const wclWiFiEapMethodType &EapMethod, const unsigned char *const Data, const unsigned long Size)
 The function sets the Extensible Authentication Protocol (EAP) user credentials as specified by raw EAP data.
 
int ShowUIEdit (const GUID &IfaceId, const tstring &ProfileName, const wclWiFiProfileEditPage Page=epConnection)
 Displays the wireless profile user interface (UI). This UI is used to view and edit advanced settings of a wireless network profile.
 
- 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

int InternalClose ()
 Executes additional finalization procedures.
 
int InternalOpen ()
 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

Provides access to the Wireless Network profiles.

An application uses this component to manage the Wireless LAN profiles.

In order to receiver the profile changes notifications an application must use the CwclWiFiEvents component.