TCPIP_DHCPS_StatisticsDataGet Function
C
TCPIP_DHCPS_RES TCPIP_DHCPS_StatisticsDataGet(TCPIP_NET_HANDLE netH, TCPIP_DHCPS_STATISTICS_DATA* pStatData);
Description
Returns the DHCPS statistics data
This function is used to return the DHCPS statistics data
Precondition
The DHCP Server module should have been initialized.
Parameters
| Parameters | Description |
|---|---|
| hNet | selected interface handle |
| pStatData | address to store the statistics |
| Could be NULL |
Returns
- TCPIP_DHCPS_RES_OK - if the DHCP server runs on the selected interface and statistics are copied to pStatData
- < 0 - if wrong interface or DHCP server is not running on that interface
- TCPIP_DHCPS_RES_ACCESS_LOCKED - if access to the DHCP server DB is locked by another thread and the the call can be retried. Multi-threaded access is enabled (build symbol TCPIP_DHCPS_MULTI_THREADED_ACCESS != 0)
Remarks
The symbol TCPIP_DHCPS_ENABLE_STATISTICS needs to be defined and != 0 for this function to exist.