Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Stop dynamic IP IPv4 address configuration for an interface.

Files

net_ipipv4.h/net_ipipv4.c

Prototype

Arguments

if_nbr

Interface number to stop dynamic address configuration.

perrp_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_OS_ERR_LOCK

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.