Description
Get an interface's IPv6 host address(es).
Files
net_ipv6.h/net_ipv6.c
Prototype
Code Block |
---|
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 configureget 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) pass :
- Pass the size of the address table, in number of IPv6 addresses, pointed to by 'p_addr_tbl'.
...
- Return the actual number of IPv6 addresses, if NO error(s)
- 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_ERR_INIT_INCOMPLETE
NET_IPv6_ERR_INVALID_ADDR_CFG_MODENOT_COMPLETED
NET_IPv6_ERR_ADDRFAULT_CFGNULL_STATEPTR
NET_IPv6_ERR_ADDR_TBLNONE_FULLAVAIL
NET_IPv6_ERR_ADDR_CFG_IN_USEPROGRESS
NET_IPv6_ERR_INVALID_ADDR_HOSTNET_IPv6_ERR_INVALID_ADDR_PREFIX_LEN
TBL_SIZE
NET_IF_ERR_INVALID_IFNET_ERR_FAULT_LOCK_ACQUIRE
Returned Value
DEF_OK
, if valid interface's IPv6 address configuredhost address(s) successfully returned..
DEF_FAIL
, otherwise.
Required Configuration
None.
Notes / Warnings
None.