RtecatStopComponent
RtecatStopComponent stops all running E-CAT MainDevice instances.
Syntax
BOOL RtecatStopComponent();
Return Values
If the function succeeds, 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 codes | Meaning |
|---|---|
|
RT_ERROR_SUBSYSTEM_NOT_STARTED |
The Subsystem is not running. |
|
RTECAT_ERROR_STOPPED |
There is no E-CAT component instance running. |
|
ERROR_ABANDONED_WAIT_0 |
Failed to acquire the synchronization lock. |
|
RTECAT_ERROR_NO_EVENT |
An instance mutex was not found. |
|
RTECAT_ERROR_TIMEOUT_STOPING |
Instance failed to stop within the 10-second timeout period. |
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
wRTOS 1.0 SDK |
RtecatComponent.h |
RtecatApi_W64.lib (Windows), RtecatApi.lib (RTSS) |
See Also: