NetSock_CfgIF

Configure the interface that must be used by the socket.

Files

net_sock.h/net_sock.c

Prototype

          CPU_BOOLEAN NetSock_CfgIF(NET_SOCK_ID   sock_id,
                                    NET_IF_NBR    if_nbr,
                                    NET_ERR      *p_err);

Arguments

sock_id

This is the socket ID returned by NetSock_Open()/socket() when the socket was created.

if_nbr

Interface number that must be used.

p_err

Pointer to variable that will receive the return error code from this function:
NET_SOCK_ERR_NONE
NET_SOCK_ERR_NOT_USED
NET_SOCK_ERR_INVALID_SOCK
NET_INIT_ERR_NOT_COMPLETED
NET_CONN_ERR_NOT_USED
NET_ERR_FAULT_LOCK_ACQUIRE


Returned Value

DEF_OK,

interface number successfully configured.

DEF_FAIL, otherwise.

Required Configuration

none.

Notes / Warnings

None.