NetIPv6_CfgAddrRemoveAll

Description

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

Files

net_ipv6.h/net_ipv6.c

Prototype

          CPU_BOOLEAN NetIPv6_CfgAddrRemoveAll(NET_IF_NBR   if_nbr,
                                               NET_ERR     *p_err);

Arguments

if_nbr

Interface number to remove address configuration.

p_err

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

NET_IPv6_ERR_NONE
NET_IPv6_ERR_ADDR_CFG_STATE
NET_INIT_ERR_NOT_COMPLETED
NET_IF_ERR_INVALID_IF
NET_ERR_FAULT_LOCK_ACQUIRE

Returned Value

DEF_OK, if ALL interface's configured IPv6 host address(es) successfully removed.

DEF_FAIL, otherwise.

Required Configuration

None.

Notes / Warnings

None.