CwclWiFiClient Class Reference

The CwclWiFiClient component provides access to the Wireless LAN client functions. More...

#include <wclWiFi.h>

Inheritance diagram for CwclWiFiClient:

Public Member Functions
	CwclWiFiClient ()
	Creates new object.
int	EnumInterfaces (wclWiFiInterfaces &Ifaces)
	Enumerates all of the wireless LAN interfaces currently enabled on the local computer.
int	EnumAvailableNetworks (const GUID &IfaceId, const wclWiFiAvailableNetworkFilters &Filters, wclWiFiAvailableNetworks &Networks)
	Retrieves the list of available networks on a wireless LAN interface.
int	EnumBss (const GUID &IfaceId, const tstring &Ssid, const wclWiFiBssType BssType, const bool SecurityEnabled, wclWiFiBssArray &BssList)
	The method retrieves a list of the basic service set (BSS) entries of the wireless network or networks on a given wireless LAN interface.
int	Scan (const GUID &IfaceId)
	The Scan function requests a scan for available networks.
int	Scan (const GUID &IfaceId, const tstring &Ssid)
	The Scan function requests a scan for available networks.
int	Scan (const GUID &IfaceId, const wclWiFiScanIeData &Ie)
	The Scan function requests a scan for available networks.
int	Scan (const GUID &IfaceId, const tstring &Ssid, const wclWiFiScanIeData &Ie)
	The Scan function requests a scan for available networks.
int	Connect (const GUID &IfaceId, const wclWiFiConnectionMode Mode, const tstring &Profile, const tstring &Ssid, const wclWiFiBssType BssType, const wclWiFiConnectFlags &Flags, const wclWiFiBssList &BssList)
	The method attempts to connect to a specific network.
int	Connect (const GUID &IfaceId, const wclWiFiConnectionMode Mode, const tstring &Profile, const tstring &Ssid, const wclWiFiBssType BssType, const wclWiFiConnectFlags &Flags, const tstring &Bss)
	The method attempts to connect to a specific network.
int	Connect (const GUID &IfaceId, const wclWiFiConnectionMode Mode, const tstring &Profile, const tstring &Ssid, const wclWiFiBssType BssType, const wclWiFiConnectFlags &Flags)
	The method attempts to connect to a specific network.
int	Disconnect (const GUID &IfaceId)
	Disconnects an interface from its current network.
int	AcmGetShowDeniedNetworks (bool &Show) const
	Reads the WLAN ACM value indicating whether user and group policy-denied networks will be included in the available networks list.
int	AcmGetPowerSetting (wclWiFiPowerSetting &Setting) const
	Reads the WLAN ACM Power Setting.
int	AcmGetOnlyUseGpProfiles (bool &Enabled) const
	Reads the ACM value indicating whether profiles not created by group policy can be used to connect to an allowed network with a matching group policy profile.
int	AcmGetAllowExplicitCreds (bool &Allow) const
	Reads the ACM value indicating whether the current wireless interface has shared user credentials allowed.
int	AcmGetBlockPeriod (unsigned long &Period) const
	Read the ACM value that indicates the blocked period setting for the current wireless interface.
int	AcmGetVirtualStationExtensibility (bool &Allowed) const
	Reads the ACM value indicating whether extensibility on a virtual station is allowed.
int	AcmSetShowDeniedNetworks (const bool Show)
	Sets the WLAN ACM value indicating whether user and group policy-denied networks will be included in the available networks list.
int	AcmSetAllowExplicitCreds (const bool Allow)
	Sets the ACM value indicating whether the current wireless interface has shared user credentials allowed.
int	AcmSetBlockPeriod (const unsigned long Period)
	Sets the ACM value that indicates the blocked period setting for the current wireless interface.
int	AcmSetVirtualStationExtensibility (const bool Allowed)
	Sets the ACM value indicating whether extensibility on a virtual station is allowed.
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 CwclCustomWiFiComponent
int	RequestAccess ()
	The function requests access to the WiFi features on Win 11 24H2 and above.
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 CwclWiFiClient component provides access to the Wireless LAN client functions.

The component is not thread-safe and must be used in one thread in which it was created.

In order to be notified about the WLAN events an application must use the CwclWiFiEvents component.

See also

CwclCustomWiFiComponent