Inherits NetOceanDirect::ManagedObject< DHCPServerConfigurationAPI >.
|
bool | isDHCPServerEnabled (long deviceID, int %errorCode, unsigned char ifNum) |
|
void | readDHCPServerAddressRange (long deviceID, int %errorCode, unsigned char ifNum, cli::array< unsigned int > ^%outBaseIpAddress, unsigned int %outNetmask) |
|
void | setDHCPServerAddressRange (long deviceID, int %errorCode, unsigned char ifNum, cli::array< unsigned int > ^baseIpAddress, unsigned int netMask) |
|
void | setDHCPServerEnable (long deviceID, int %errorCode, unsigned char ifNum, unsigned char enabled) |
|
| ManagedObject (DHCPServerConfigurationAPI *instance) |
|
DHCPServerConfigurationAPI * | GetInstance () |
|
|
DHCPServerConfigurationAPI * | m_Instance |
|
◆ isDHCPServerEnabled()
bool DHCPServerConfiguration::isDHCPServerEnabled |
( |
long |
deviceID, |
|
|
int % |
errorCode, |
|
|
unsigned char |
ifNum |
|
) |
| |
Only valid for WiFi interfaces. Retrieves the DHCP server status whether it is enabled or not.
- See also
- setDHCPServerEnable()
- Parameters
-
[in] | deviceID | the device ID for the device to be queried (from OceanDirect::findDevices()) |
[in] | ifNum | the interface number |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise |
- Returns
- true if the DHCP is enable otherwise it will be false.
◆ readDHCPServerAddressRange()
void DHCPServerConfiguration::readDHCPServerAddressRange |
( |
long |
deviceID, |
|
|
int % |
errorCode, |
|
|
unsigned char |
ifNum, |
|
|
cli::array< unsigned int > ^% |
outBaseIpAddress, |
|
|
unsigned int % |
outNetmask |
|
) |
| |
Only valid for WiFi interfaces. Reads the address range and netmask .
- See also
- setDHCPServerAddressRange()
- Parameters
-
[in] | deviceID | the device ID for the device to be queried (from OceanDirect::findDevices()) |
[in] | ifNum | the interface number |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise |
[out] | outBaseIpAddress | set the base ip address value. |
[out] | outNetmask | set the netmask value. |
◆ setDHCPServerAddressRange()
void DHCPServerConfiguration::setDHCPServerAddressRange |
( |
long |
deviceID, |
|
|
int % |
errorCode, |
|
|
unsigned char |
ifNum, |
|
|
cli::array< unsigned int > ^ |
baseIpAddress, |
|
|
unsigned int |
netMask |
|
) |
| |
Only valid for WiFi interfaces. Set the address range of the DHCP server. If the bitwise anding of the expanded netmask and the IPv4 Base Address is not equal to the IPv4 Base Address, then the device will return a NACK. A base address of 192.168.0.0 with a netmask of 16 [255.255.0.0] is a valid configuration and the DHCP server will have an address of 192.168.0.1. A base address of 192.168.10.0 with a netmask of 16 [255.255.0.0] is an invalid configuration, because 192.168.10.0 bitwise anded with 255.255.0.0 equals 192.168.0.0 which differs from the base IPv4 address
- See also
- readDHCPServerAddressRange()
- Parameters
-
[in] | deviceID | the device ID for the device to be queried (from OceanDirect::findDevices()) |
[in] | ifNum | the interface number |
[in] | baseIpAddress | the base ip address. |
[in] | netMask | the base ip address. |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise |
◆ setDHCPServerEnable()
void DHCPServerConfiguration::setDHCPServerEnable |
( |
long |
deviceID, |
|
|
int % |
errorCode, |
|
|
unsigned char |
ifNum, |
|
|
unsigned char |
enabled |
|
) |
| |
Only valid for WiFi interfaces. Enable or disable the DHCP server.
- See also
- isDHCPServerEnabled()
- Parameters
-
[in] | deviceID | the device ID for the device to be queried (from OceanDirect::findDevices()) |
[in] | ifNum | the interface number |
[in] | enable | true will enable the server. False will disable the server. |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise |
The documentation for this class was generated from the following files: