Rtfwnl2StopComponent stops the Network Link Layer (NL2) component.
Syntax
BOOL Rtnl2_API Rtfwnl2StopComponent(); 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 are 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_SUBSYSTEM_NOT_STARTED |
The Subsystem is not running. |
Remarks
The NL2 component cannot be stopped when other applications are using it.
This function will not return until the NL2 has stopped completely.
This function will attempt to stop all running components dependent on the NL2 (TCPIP, gPTP, etc.). If those dependent components fail to stop, this function will fail, and the last error will reflect the attempt to stop those dependent components If other NL2 client applications are running in addition to the dependent components, those components may still be stopped, but Rtfwnl2StopComponent will still return failure.
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
wRTOS 1.0 SDK |
Rtnl2Component.h |
Rtfwnl2Api.lib (Windows), Rtnl2Api.lib (RTSS) |
