TCPIP_STACK_NetUp Function

C

bool TCPIP_STACK_NetUp(
    TCPIP_NET_HANDLE netH, 
    const TCPIP_NETWORK_CONFIG* pUsrConfig
);

Description

This function brings a network interface up and perform its initialization.

Preconditions

The TCP/IP stack should have been initialized by TCPIP_STACK_Initialize() and the TCPIP_STACK_Status() returned SYS_STATUS_READY.

Parameters

ParametersDescription
netHInterface handle.
pUsrConfigPointer to a TCPIP_NETWORK_CONFIG for the interface initialization.

Returns

  • True - If success.

  • False - If no such network or an error occurred.

Remarks

If the interface to be brought up is a primary interface, then all its aliases remain turned down. A separate call to TCPIP_STACK_NetUp() is needed for each of the aliases.

If the interface to be brought up is an alias interface, the primary interface of this alias has to be up and running. A separate call to TCPIP_STACK_NetUp() is needed for each of the aliases.