Stop dynamic IP IPv4 address configuration for an interface.
Files
net_ipipv4.h/net_ipipv4.c
Prototype
Code Block |
---|
CPU_BOOLEAN NetIPv4_CfgAddrAddDynamicStop(NET_IF_NBR if_nbr,
NET_ERR *p_err); |
Arguments
if_nbr
Interface number to stop dynamic address configuration.
perr
p_err
Pointer to variable that will receive the return error code from this function:
NET_IPIPv4_ERR_NONE
NET_IPIPv4_ERR_ADDR_CFG_STATE
NET_IF_ERR_INVALID_IF
NET_OSERR_ERRFAULT_LOCK_ACQUIRE
Returned Value
DEF_OK
,
if dynamic IP IPv4 address configuration successfully stopped;
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 IP IPv4 address(es), it must call NetIPNetIPv4_CfgAddrAddDynamicStop()
only after calling NetIPNetIPv4_CfgAddrAddDynamicStart()
and dynamic IP IPv4 address configuration has failed.