RtecatStopInstance

RtecatStopInstance stops a running E-CAT MainDevice instance.

Syntax

Copy

BOOL RtecatStopInstance(
  [in]    ULONG Instance
);

Parameters

[in] Instance

The instance to stop. The maximum number of instances is 63 (0-62), as defined by RTECAT_MAX_INSTANCE in the header file.

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
ERROR_INVALID_PARAMETER	The value of parameter Instance is outside the acceptable range (0-62).
RT_ERROR_SUBSYSTEM_NOT_STARTED	The Subsystem is not running.
RTECAT_ERROR_STOPPED	The instance is not running.
ERROR_ABANDONED_WAIT_0	Failed to acquire the synchronization lock.
RTECAT_ERROR_NO_EVENT	The instance event 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)