Visioscan Set SDK Libraries 1.0.14
Visioscan Set SDK Help documentation file for C++ and C++/CLI
 
Loading...
Searching...
No Matches
NetworkInformation Class Reference

Helper to encapsulate the network information. More...

#include <NetworkInformation.h>

Public Member Functions

string GetIpAddress ()
 Gets the IP v4 Address.
 
void SetIpAddress (string pIP)
 Sets the IP v4 Address.
 
int GetIpPort ()
 Gets the tcp/ip comm port.
 
void SetIpPort (int pPort)
 Sets the tcp/ip comm port.
 
string GetGateway ()
 Gets the gateway Address.
 
void SetGateway (string pGateway)
 Sets the Gateway address.
 
string GetSubnetMask ()
 Gets the subnet mask.
 
void SetSubnetMask (string pSubnetMask)
 Sets the subnet mask.
 
bool GetDhcpMode ()
 Gets the dhcp mode.
 
void SetDhcpMode (bool pEnabled)
 Sets the dhcp mode.
 

Detailed Description

Helper to encapsulate the network information.

Member Function Documentation

◆ GetDhcpMode()

bool NetworkInformation::GetDhcpMode ( )

Gets the dhcp mode.

Returns
dhcp mode as a boolean (true: ON, false: OFF)

◆ GetGateway()

string NetworkInformation::GetGateway ( )

Gets the gateway Address.

Returns
Gateway address as a string

◆ GetIpAddress()

string NetworkInformation::GetIpAddress ( )

Gets the IP v4 Address.

Returns
IP Address as a string

◆ GetIpPort()

int NetworkInformation::GetIpPort ( )

Gets the tcp/ip comm port.

Returns
TCP Port as an int

◆ GetSubnetMask()

string NetworkInformation::GetSubnetMask ( )

Gets the subnet mask.

Returns
Subnet mask as a string

◆ SetDhcpMode()

void NetworkInformation::SetDhcpMode ( bool  pEnabled)

Sets the dhcp mode.

Parameters
pEnabledThe DHCP mode to be set (true: ON, false: OFF)

◆ SetGateway()

void NetworkInformation::SetGateway ( string  pGateway)

Sets the Gateway address.

Parameters
pGatewayThe gateway address v4 to be set

◆ SetIpAddress()

void NetworkInformation::SetIpAddress ( string  pIP)

Sets the IP v4 Address.

Parameters
pIPThe IP Address v4 to be set

◆ SetIpPort()

void NetworkInformation::SetIpPort ( int  pPort)

Sets the tcp/ip comm port.

Parameters
pPorttcp/ip port as an int

◆ SetSubnetMask()

void NetworkInformation::SetSubnetMask ( string  pSubnetMask)

Sets the subnet mask.

Parameters
pSubnetMaskThe subnet mask v4 to be set

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