NetIPv4_CfgAddrAddDynamicStart
Start dynamic IPv4 address configuration for an interface.
Files
net_ipv4.h/net_ipv4.c
Prototype
CPU_BOOLEAN NetIPv4_CfgAddrAddDynamicStart(NET_IF_NBR if_nbr, NET_ERR *p_err);
Arguments
if_nbr
Interface number to start dynamic address configuration.
p_err
Pointer to variable that will receive the return error code from this function:
NET_IPv4_ERR_NONE
NET_IPv4_ERR_ADDR_CFG_STATE
NET_IPv4_ERR_ADDR_CFG_IN_PROGRESS
NET_IF_ERR_INVALID_IF
NET_ERR_FAULT_LOCK_ACQUIRE
Returned Value
DEF_OK
,
if dynamic IPv4 address configuration successfully started;
DEF_FAIL
,
otherwise.
Required Configuration
None.
Notes / Warnings
This function should only be called by appropriate network application function(s) [e.g., DHCP initialization functions]. However, if the application attempts to dynamically configure IPv4 address(es), it must call NetIPv4_CfgAddrAddDynamicStart()
before calling NetIPv4_CfgAddrAddDynamic
.