Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvNetworkAdapter Class Reference

Represents one Ethernet network adapter on a system (the PC) More...

Public Member Functions

 PvNetworkAdapter ()
 Constructor.
 
virtual ~PvNetworkAdapter ()
 Destructor.
 
PvString GetMACAddress () const
 Get the NIC's MAC address. More...
 
PvString GetDescription () const
 Returns the operating system provided description of the network adapter. More...
 
uint32_t GetIPAddressCount () const
 Returns one of the IP addresses for the network adapter, index-based. More...
 
PvString GetIPAddress (uint32_t aIndex) const
 Returns the IP address of the network adapter. More...
 
PvString GetSubnetMask (uint32_t aIndex) const
 Returns the subnet mask of one of the IP addresses of the network adapter. More...
 
PvString GetDefaultGateway () const
 The NIC's default gateway. More...
 
bool IsPleoraDriverInstalled () const
 Returns true if the Pleora driver is installed on this network interface. More...
 
- Public Member Functions inherited from PvInterface
virtual ~PvInterface ()
 Destructor.
 
PvInterfaceType GetType () const
 Get the interface type. More...
 
PvString GetName () const
 Get the description of the NIC, as reported by the OS. More...
 
PvString GetDisplayID () const
 Get a string that can be used in a user interface to identify the interface. More...
 
PvString GetUniqueID () const
 Get a string uniquely identifying the interface. More...
 
PvString GetCompareID () const
 Get a string that can be used to sort interfaces. More...
 
uint32_t GetDeviceCount () const
 Get the number of found devices on this PvInterface. More...
 
const PvDeviceInfoGetDeviceInfo (uint32_t aIndex) const
 Get information identifying a device. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from PvInterface
static bool Compare (const PvInterface *a1, const PvInterface *a2)
 Static method used for sorting interfaces. More...
 

Detailed Description

Represents one Ethernet network adapter on a system (the PC)

To use this class, see PvSystem.

Member Function Documentation

PvString PvNetworkAdapter::GetDefaultGateway ( ) const

The NIC's default gateway.

Returns
The NIC's default gateway. The form follows that of GetIPAddress.
PvString PvNetworkAdapter::GetDescription ( ) const

Returns the operating system provided description of the network adapter.

Returns
Description of the network adapter.
PvString PvNetworkAdapter::GetIPAddress ( uint32_t  aIndex) const

Returns the IP address of the network adapter.

IP addresses and subnet masks are enumerated together. The subnet mask of 0 matches the IP addresses of 0, etc.

Parameters
[in]aIndexThe IP configuration index.
Returns
One of the IP addresses of the network adapter.
uint32_t PvNetworkAdapter::GetIPAddressCount ( ) const

Returns one of the IP addresses for the network adapter, index-based.

IP addresses and subnet masks are enumerated together. GetIPAddressCount is used to get the 0-based range that can be used with both GetIPAddress and GetSubnetMask. The subnet mask of 0 matches the IP addresses of 0, etc.

Returns
One of the IP addresses used by the adapter represented as a string.
PvString PvNetworkAdapter::GetMACAddress ( ) const

Get the NIC's MAC address.

Returns
The NIC's MAC address. The form is ##.##.##.##.##.##, where # is a 0-9 or A-F.
PvString PvNetworkAdapter::GetSubnetMask ( uint32_t  aIndex) const

Returns the subnet mask of one of the IP addresses of the network adapter.

IP addresses and subnet masks are enumerated together. The subnet mask of 0 matches the IP addresses of 0, etc.

Parameters
[in]aIndexThe IP configuration index.
Returns
One of the IP addresses of the network adapter.
bool PvNetworkAdapter::IsPleoraDriverInstalled ( ) const

Returns true if the Pleora driver is installed on this network interface.

Returns
True if the Pleora driver is installed on this network interface.

The documentation for this class was generated from the following files:

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com