NetIF_LinkStateGet

Get network interface’s last known physical link state.

Files

net_if.h/net_if.c

Prototype

          CPU_BOOLEAN NetIF_LinkStateGet(NET_IF_NBR  if_nbr,
                                         NET_ERR    *p_err);

Arguments

if_nbr

Network interface number to get last known physical link state.

p_err

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

NET_IF_ERR_NONE
NET_IF_ERR_INVALID_IF
NET_ERR_FAULT_LOCK_ACQUIRE

Returned Value

NET_IF_LINK_UP

if no errors and network interface’s last known physical link state was ‘UP’;

NET_IF_LINK_DOWN

otherwise.

Required Configuration

None.

Notes / Warnings

Use NetIF_IO_Ctrl() with option NET_IF_IO_CTRL_LINK_STATE_GET to get a network interface’s current physical link state.

See section Network Interface Link State for more information on how to get the Link State.