IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


void Get_DHCP_Status_Ext ( unsigned int *  dhcpUse,
unsigned int *  dhcpStat,
UserEthDhcp_Entry **  dhcpBootDataPtr 
)

Retrieve DHCP status of the ethernet interface.

Parameters:
[out] dhcpUse Pointer to a where a "DHCP in use" boolean value will be output to. The location will be set to '1' if the DHCP is currently being used and '0' if not in use.
[out] dhcpStat Pointer to a where a DHCP status word will be stored. The reported status is valid if dhcpUse==1.
The status is encoded as follows:

  • 0: System is not configured (is in progress)
  • 1: System is configured by a DHCP Server
  • 2: System configure retry failed (or no retry started before)
[out] dhcpBootDataPtr Pointer to a pointer that will be set by this API call, referencing a UserEthDhcp_Entry data structure within @CHIP-RTOS-PPC's memory. This structure will contain some DHCP configuration data (read-only!). If no data is available the pointer will be set to NULL.
Returns:
Returns nothing
Deprecated:
This legacy function can be replaced by Dev_Get_DHCP_BootData().
It is only left for backward compatibility.





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Thu Jan 26 16:21:39 2017 by Doxygen 1.6.1