Rtnl2StopComponent

Rtnl2StopComponent stops the Network Link Layer (NL2) component.

Syntax

Copy
BOOL Rtnl2_API Rtnl2StopComponent(); 

Parameters

This function has no parameters.

Return Value

If the function succeeds, and the component stops, 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

ERROR_PROC_NOT_FOUND

Unable to load dependent component control libraries, which prevents shutdown of dependent component processes.

RT_ERROR_NL2_CLIENTS_EXIST

One or more NL2 client applications is still running.

RT_ERROR_NL2_STOPPED

The NL2 component is not running.

RT_ERROR_NO_LICENSE

The NL2 component does not have a valid license.

RT_ERROR_TIMEOUT_QUERYING_NL2_STATUS

An issue has occurred while querying the status of the NL2 component.

RT_ERROR_KERNEL_NOT_STARTED

The Kernel is not running,

Remarks

The NL2 component cannot be stopped when other applications are using it.

Characteristics

Real-time

Deterministic

No

Local memory usage

Process

External MSpace usage

Internal MSpace usage

System

Yes (Shared Memory)

Yes (Shared Memory, Mutexes)

NL2 process

No

No

Calling process

No

No

Contiguous memory usage

Usage

No

Requirements

Minimum supported version Header Library

eRTOS 1.0 SDK

Rtnl2Component.h

Rtnl2Api.lib

See Also: