Regatron.G5.Api.System.EthernetConfiguration Class Reference

Public Member Functions
String	GetMacAddress ()
	Get actual MAC address.
String	GetDeviceName ()
	Get actual device name.
Boolean	IsDhcpEnabled ()
	Get if DHCP is active.
IPAddress	GetIpAddress ()
	Get actual IP address.
IPAddress	GetStaticIpAddress ()
	Get a dedicated IP address that has been assigned.
Boolean	SetStaticIpAddress (IPAddress address)
	Set a dedicated IP address.
IPAddress	GetStaticSubnetMask ()
	Get a dedicated sub mask.
Boolean	SetStaticSubnetMask (IPAddress value)
	Set a dedicated sub mask address.
IPAddress	GetStaticGateway ()
	Get a static gateway.
Boolean	SetStaticGateway (IPAddress value)
	Set a static gateway address.
IPAddress	GetSubnetMask ()
	Get actual subnet mask.
IPAddress	GetGateway ()
	Get actual gateway.
IPAddress	GetIpV6Address ()
	Get actual IPv6 address.
MediaState	GetMediaState (UInt16 physicalPortNumber)
	Get actual MediaState.
ConnectionSpeed	GetConnectionSpeed (UInt16 physicalPortNumber)
	Get actual ConnectionSpeed.
DuplexMode	GetDuplexMode (UInt16 physicalPortNumber)
	Get actual DuplexMode.
Boolean	EnableDhcp ()
	Try to enable the DHCP.
Boolean	DisableDhcp ()
	Try to disable the DHCP.
Boolean	ChangeSettings ()
	Write all settings to the device. For example change IP address etc.

Member Function Documentation

ChangeSettings()

Boolean Regatron.G5.Api.System.EthernetConfiguration.ChangeSettings ( )

inline

Write all settings to the device. For example change IP address etc.

Returns

Returns true if this operation is successful

Exceptions

G5ApiException

DisableDhcp()

Boolean Regatron.G5.Api.System.EthernetConfiguration.DisableDhcp ( )

inline

Try to disable the DHCP.

Returns

Returns true if dynamic IP is disabled

Exceptions

G5ApiException

EnableDhcp()

Boolean Regatron.G5.Api.System.EthernetConfiguration.EnableDhcp ( )

inline

Try to enable the DHCP.

Returns

Returns true if dynamic IP is active

Exceptions

G5ApiException

GetConnectionSpeed()

ConnectionSpeed Regatron.G5.Api.System.EthernetConfiguration.GetConnectionSpeed ( UInt16 physicalPortNumber )

inline

Get actual ConnectionSpeed.

Parameters

physicalPortNumber

This parameter must be only 0 or 1

Returns

Returns the actual ConnectionSpeed

Exceptions

G5ApiException

GetDeviceName()

String Regatron.G5.Api.System.EthernetConfiguration.GetDeviceName ( )

inline

Get actual device name.

Returns

Returns the actual device name

Exceptions

G5ApiException

GetDuplexMode()

DuplexMode Regatron.G5.Api.System.EthernetConfiguration.GetDuplexMode ( UInt16 physicalPortNumber )

inline

Get actual DuplexMode.

Parameters

physicalPortNumber

This parameter must be only 0 or 1

Returns

Returns the actual DuplexMode

Exceptions

G5ApiException

GetGateway()

IPAddress Regatron.G5.Api.System.EthernetConfiguration.GetGateway ( )

inline

Get actual gateway.

Returns

Returns the actual gateway

Exceptions

G5ApiException

GetIpAddress()

IPAddress Regatron.G5.Api.System.EthernetConfiguration.GetIpAddress ( )

inline

Get actual IP address.

Returns

Returns the actual IP address

Exceptions

G5ApiException

GetIpV6Address()

IPAddress Regatron.G5.Api.System.EthernetConfiguration.GetIpV6Address ( )

inline

Get actual IPv6 address.

Returns

Returns the actual IPv6 address

Exceptions

G5ApiException

GetMacAddress()

String Regatron.G5.Api.System.EthernetConfiguration.GetMacAddress ( )

inline

Get actual MAC address.

Returns

Returns the actual MAC address

Exceptions

G5ApiException

GetMediaState()

MediaState Regatron.G5.Api.System.EthernetConfiguration.GetMediaState ( UInt16 physicalPortNumber )

inline

Get actual MediaState.

Parameters

physicalPortNumber

This parameter must be only 0 or 1

Returns

Returns the actual MediaState

Exceptions

G5ApiException

GetStaticGateway()

IPAddress Regatron.G5.Api.System.EthernetConfiguration.GetStaticGateway ( )

inline

Get a static gateway.

Returns

Returns the static gateway

Exceptions

G5ApiException

GetStaticIpAddress()

IPAddress Regatron.G5.Api.System.EthernetConfiguration.GetStaticIpAddress ( )

inline

Get a dedicated IP address that has been assigned.

Returns

Returns the static IP address

Exceptions

G5ApiException

GetStaticSubnetMask()

IPAddress Regatron.G5.Api.System.EthernetConfiguration.GetStaticSubnetMask ( )

inline

Get a dedicated sub mask.

Returns

Returns the static sub mask

Exceptions

G5ApiException

GetSubnetMask()

IPAddress Regatron.G5.Api.System.EthernetConfiguration.GetSubnetMask ( )

inline

Get actual subnet mask.

Returns

Returns the actual subnet mask

Exceptions

G5ApiException

IsDhcpEnabled()

Boolean Regatron.G5.Api.System.EthernetConfiguration.IsDhcpEnabled ( )

inline

Get if DHCP is active.

Returns

Returns true if DHCP is activate. Get false if static addressing is active

Exceptions

G5ApiException

SetStaticGateway()

Boolean Regatron.G5.Api.System.EthernetConfiguration.SetStaticGateway ( IPAddress value )

inline

Set a static gateway address.

Returns

Returns true if the setting of the static gateway address is successful

Exceptions

G5ApiException

SetStaticIpAddress()

Boolean Regatron.G5.Api.System.EthernetConfiguration.SetStaticIpAddress ( IPAddress address )

inline

Set a dedicated IP address.

Returns

Returns true if the setting of the static IP address is successful

Exceptions

G5ApiException

SetStaticSubnetMask()

Boolean Regatron.G5.Api.System.EthernetConfiguration.SetStaticSubnetMask ( IPAddress value )

inline

Set a dedicated sub mask address.

Returns

Returns true if the setting of the static sub mask address is successful

Exceptions

G5ApiException