NetIPv4_CfgAddrAddDynamicStop

Owned by Former user (Deleted)
Last updated: Dec 10, 2020 by WES Admin
1 min read

Stop dynamic IPv4 address configuration for an interface.

Files

net_ipv4.h/net_ipv4.c

Prototype

          CPU_BOOLEAN NetIPv4_CfgAddrAddDynamicStop(NET_IF_NBR  if_nbr,
                                                    NET_ERR    *p_err);

Arguments

if_nbr

Interface number to stop 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_IF_ERR_INVALID_IF
NET_ERR_FAULT_LOCK_ACQUIRE

Returned Value

DEF_OK,

if dynamic 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 IPv4 address(es), it must call NetIPv4_CfgAddrAddDynamicStop() only after calling NetIPv4_CfgAddrAddDynamicStart and dynamic IPv4 address configuration has failed.