NetIPv6_CfgAddrRemove

Description

Remove a configured IPv6 host address & multicast solicited mode address from an interface.

Files

net_ipv6.h/net_ipv6.c

Prototype

          CPU_BOOLEAN NetIPv6_CfgAddrRemove(NET_IF_NBR      if_nbr,
                                            NET_IPv6_ADDR  *p_addr_host,
                                            NET_ERR        *p_err);

Arguments

if_nbr

Interface number to remove address configuration

p_addr_host

Pointer to IPv6 address to remove.

p_err

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

NET_IPv6_ERR_NONE
NET_IPv6_ERR_INVALID_ADDR_HOST
NET_IPv6_ERR_ADDR_CFG_STATE
NET_IPv6_ERR_ADDR_TBL_EMPTY
NET_IPv6_ERR_ADDR_NOT_FOUND
NET_INIT_ERR_NOT_COMPLETED
NET_IF_ERR_INVALID_IF
NET_ERR_FAULT_LOCK_ACQUIRE

Returned Value

DEF_OK, if IPv6 configured address removed.

DEF_FAIL, otherwise.

Required Configuration

None.

Notes / Warnings

None.