OceanDirectLighthouseC++  3.1.1
OceanDirect Lighthouse C++/C API
oceandirect::api::DHCPServerConfigurationAPI Class Reference

Public Member Functions

bool isDHCPServerEnabled (long deviceID, int *errorCode, unsigned char ifNum)
 
void readDHCPServerAddressRange (long deviceID, int *errorCode, unsigned char ifNum, unsigned int *outBaseIpAddress, unsigned int ipAddressArraySize, unsigned int *outNetMask)
 
void setDHCPServerAddressRange (long deviceID, int *errorCode, unsigned char ifNum, const unsigned int *baseIpAddress, unsigned int ipAddressArraySize, unsigned int netMask)
 
void setDHCPServerEnable (long deviceID, int *errorCode, unsigned char ifNum, unsigned char enabled)
 

Static Public Member Functions

static DHCPServerConfigurationAPIgetInstance ()
 
static void shutdown ()
 

Member Function Documentation

◆ isDHCPServerEnabled()

bool oceandirect::api::DHCPServerConfigurationAPI::isDHCPServerEnabled ( long  deviceID,
int *  errorCode,
unsigned char  ifNum 
)

Determine if the DHCP server is enabled on a specified interface e.g. Ethernet, wifi.

See also
setDHCPServerEnable()
Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
ifNumthe specified interface.
Returns
true if the DHCP server is enabled on the specified interface, false otherwise.

◆ readDHCPServerAddressRange()

void oceandirect::api::DHCPServerConfigurationAPI::readDHCPServerAddressRange ( long  deviceID,
int *  errorCode,
unsigned char  ifNum,
unsigned int *  outBaseIpAddress,
unsigned int  ipAddressArraySize,
unsigned int *  outNetMask 
)

Get the addess range for the DHCP server on a specified interface e.g. Ethernet, wifi.

See also
setDHCPServerAddressRange()
Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
ifNumthe specified interface.
outBaseIpAddress
ipAddressArraySizethe size of the buffer.
outNetMaskthe netmask for the DHCP server addresses.

◆ setDHCPServerAddressRange()

void oceandirect::api::DHCPServerConfigurationAPI::setDHCPServerAddressRange ( long  deviceID,
int *  errorCode,
unsigned char  ifNum,
const unsigned int *  baseIpAddress,
unsigned int  ipAddressArraySize,
unsigned int  netMask 
)

Set the addess range for the DHCP server on a specified interface e.g. Ethernet, wifi.

See also
readDHCPServerAddressRange()
Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
ifNumthe specified interface.
baseIpAddress
ipAddressArraySizethe size of the buffer.
netMaskthe netmask for the DHCP server addresses.

◆ setDHCPServerEnable()

void oceandirect::api::DHCPServerConfigurationAPI::setDHCPServerEnable ( long  deviceID,
int *  errorCode,
unsigned char  ifNum,
unsigned char  enabled 
)

Set the DHCP server to enabled or disabled on a specified interface e.g. Ethernet, wifi.

See also
isDHCPServerEnabled()
Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found.
ifNumthe specified interface.
enabledtrue to enable DHCP, false to disable DHCP.

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