NetIPv6_AddrAutoCfgDis

Description

Disables the IPv6 Stateless Address Auto-Configuration procedure. No further Auto-Configuration will take place if the interface link state changes to UP.

However, this will not stop a current running Auto-Configuration process.

Files

net_ipv6.h/net_ipv6.c

Prototype

          CPU_BOOLEAN NetIPv6_AddrAutoCfgDis(NET_IF_NBR   if_nbr,
                                             NET_ERR     *p_err);

Arguments

if_nbr

Interface number to configure.

p_err

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

NET_IPv6_ERR_NONE
NET_INIT_ERR_NOT_COMPLETED
NET_IF_ERR_INVALID_IF
NET_ERR_FAULT_LOCK_ACQUIRE

(This list represents some common error codes that can be returned by the function but do not covers all the possible cases. Please refer to net_err.h file for more details on specific error codes.)

Returned Value

DEF_OK,     if IPv6 Stateless Auto-Configuration was successfully disabled.

DEF_FAIL, otherwise.

Required Configuration

NET_IPv6_CFG_ADDR_AUTO_CFG_EN must be enabled in the net_cfg.h file.

Notes / Warnings

None.