Rtfwnl2StartComponent

Rtfwnl2StartComponent starts the Network Link Layer (NL2) component.

Syntax

Copy
BOOL Rtnl2_API Rtfwnl2StartComponent(); 

Parameters

This function has no parameters.

Return Value

If the function succeeds, and the component starts, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code if the function fails.

Possible error codes:

Error code Meaning

RT_ERROR_NO_LICENSE

The NL2 component does not have a valid license.

RT_ERROR_TIMEOUT_STARTING_NL2

Unable to start the NL2 within a reasonable amount of time.

RT_ERROR_NL2_STARTED

The NL2 component is already started.

Remarks

The NL2 component is included in the wRTOS Runtime. It does not require an additional license.

If Rtfwnl2StartComponent is called from a Windows application, the function will attempt to start the real-time Subsystem if it is not already started. Rtfwnl2StartComponent will return FALSE if the Subsystem cannot be started.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

Rtnl2Component.h

Rtfwnl2Api.lib (Windows), Rtnl2Api.lib (RTSS)

See Also: