Versions Compared

Key

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

NetIP_CfgAddrRemoveAll()

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

Files

net_ipipv4.h/net_ipipv4.c

Prototype

...

Code Block

          CPU_BOOLEAN NetIPv4_CfgAddrRemoveAll(NET_IF_NBR  if_nbr,
                                               NET_ERR    *p_err);

Arguments

if_nbr

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

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_OSERR_ERRFAULT_LOCK_ACQUIRE

Returned Value

DEF_OK,

if all interface’s configured IP IPv4 host address(es) successfully removed;

DEF_FAIL,

otherwise.

Required Configuration

None.

Notes / Warnings

None.