NetIPv4_GetAddrHost

Get an interface’s configured IPv4 host address(es).

Files

net_ipv4.h/net_ipv4.c

Prototype

          CPU_BOOLEAN NetIPv4_GetAddrHost(NET_IF_NBR          if_nbr,
                                          NET_IPv4_ADDR      *p_addr_tbl,
                                          NET_IP_ADDRS_QTY   *p_addr_tbl_qty,
                                          NET_ERR            *p_err);

Arguments

if_nbr

Interface number to get configured IPv4 host address(es).

p_addr_tbl

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

p_addr_tbl_qty

Pointer to a variable to:

- Pass the size of the address table, in number of IPv4 addresses, pointed to by p_addr_tbl.

- Returns the actual number of IPv4 addresses, if no errors.

Returns 0, otherwise.

p_err

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

NET_IPv4_ERR_NONE
NET_IPv4_ERR_NULL_PTR
NET_IPv4_ERR_ADDR_NONE_AVAIL
NET_IPv4_ERR_ADDR_CFG_IN_PROGRESS
NET_IPv4_ERR_ADDR_TBL_SIZE
NET_IF_ERR_INVALID_IF
NET_ERR_FAULT_LOCK_ACQUIRE

Returned Value

DEF_OK,

if interface’s configured IPv4 host address(es) successfully returned;

DEF_FAIL,

otherwise.

Required Configuration

None.

Notes / Warnings

IPv4 addresses returned in host-order.