NetIPv6_GetAddrHost

Description

Get an interface's IPv6 host address(es).

Files

net_ipv6.h/net_ipv6.c

Prototype

          CPU_BOOLEAN NetIPv6_GetAddrHost(NET_IF_NBR         if_nbr,
                                          NET_IPv6_ADDRS    *p_addr_tbl,
                                          NET_IP_ADDRS_QTY   p_addr_tbl_qty,
                                          NET_ERR           *p_err);

Arguments

if_nbr

Interface number to get address(es) from.

p_addr_tbl

Pointer to IPv6 address table that will receive the IPv6 host address(es) in host-order for this interface.

p_addr_tbl_qty

Pointer to a variable to :

1. 1. Pass the size of the address table, in number of IPv6 addresses, pointed to by 'p_addr_tbl'.
  2. Return the actual number of IPv6 addresses, if NO error(s)
    Return 0, otherwise.

p_err

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

NET_IPv6_ERR_NONE
NET_INIT_ERR_NOT_COMPLETED NET_ERR_FAULT_NULL_PTR NET_IPv6_ERR_ADDR_NONE_AVAIL NET_IPv6_ERR_ADDR_CFG_IN_PROGRESS NET_IPv6_ERR_ADDR_TBL_SIZE NET_IF_ERR_INVALID_IF
NET_ERR_FAULT_LOCK_ACQUIRE

Returned Value

DEF_OK, if interface's IPv6 host address(s) successfully returned..

DEF_FAIL, otherwise.

Required Configuration

None.

Notes / Warnings

None.