NetIPv4_CfgAddrRemove

Remove a configured IPv4 host address from an interface.

Files

net_ipv4.h/net_ipv4.c

Prototype

          CPU_BOOLEAN NetIPv4_CfgAddrRemove(NET_IF_NBR     if_nbr,
                                            NET_IPv4_ADDR  addr_host,
                                            NET_ERR       *p_err);

Arguments

if_nbr

Interface number to remove configured IPv4 host address.

addr_host

IPv4 address to remove.

p_err

Pointer to variable that will receive the return error code from this function:

NET_IPv4_ERR_NONE
NET_IPv4_ERR_INVALID_ADDR_HOST
NET_IPv4_ERR_ADDR_CFG_STATE
NET_IPv4_ERR_ADDR_TBL_EMPTY
NET_IPv4_ERR_ADDR_NOT_FOUND
NET_IF_ERR_INVALID_IF
NET_ERR_FAULT_LOCK_ACQUIRE

Returned Value

DEF_OK,

if interface’s configured IPv4 host address successfully removed;

DEF_FAIL,

otherwise.

Required Configuration

None.

Notes / Warnings

None.