CwclNlmNetwork Class Reference

The class represents a network on the local machine. It can also represent a collection of network connections with a similar network signature. More...

#include <wclNlm.h>

Public Member Functions
	CwclNlmNetwork (NlmApi::INetwork *const Network)
	Creates a new Network object.
virtual	~CwclNlmNetwork ()
	Frees the network class.
int	GetCategory (wclNlmNetworkCategory &Category) const
	Reads the category of the network.
int	GetConnected (bool &Connected) const
	Checks if the network has any network connectivity.
int	GetConnectedToInternet (bool &Connected) const
	Checks if the network has Internet connectivity.
int	GetConnections (wclNlmConnections &Connections) const
	The method returns an enumeration of all network connections for a network. A network can have multiple connections to it from different interfaces or different links from the same interface.
int	GetConnectivity (wclNlmConnectivityFlags &Connectivity) const
	Reads the connectivity state of the network.
int	GetDescription (tstring &Description) const
	Reads the description string for the network.
int	GetDomainType (wclNlmDomainType &DomainType) const
	Reads the domain type of a network.
int	GetName (tstring &Name) const
	Reads the name of a network.
int	GetNetworkId (GUID &Id) const
	Reads the unique identifier of a network.
int	GetTimeCreatedAndConnected (SYSTEMTIME &Created, SYSTEMTIME &Connected) const
	Reads the local date and time when the network was created and connected.
int	SetCategory (const wclNlmNetworkCategory Category)
	Sets the category of a network. Changes made take effect immediately. Administrative privileges are needed for this method.
int	SetDescription (const tstring &Description)
	Sets or replaces the description for a network.
int	SetName (const tstring &Name)
	Sets or renames a network.

Detailed Description

The class represents a network on the local machine. It can also represent a collection of network connections with a similar network signature.

An application must never create this class directly. Instead of that an application must use GetNetwork or GetNetworks methods of the CwclNetworkListManager component.