NetIPv4_CfgAddrRemoveAll

Remove all configured IPv4 host address(es) from an interface.

Files

net_ipv4.h/net_ipv4.c

Prototype

          CPU_BOOLEAN NetIPv4_CfgAddrRemoveAll(NET_IF_NBR  if_nbr,
                                               NET_ERR    *p_err);

Arguments

if_nbr

Interface number to remove all configured IPv4 host address(es).

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 all interface’s configured IPv4 host address(es) successfully removed;

DEF_FAIL,

otherwise.

Required Configuration

None.

Notes / Warnings

None.