RtecatAbortCommand

RtecatAbortCommand aborts a command.

Syntax

Copy

RTECAT_COMMAND_STATUS RtecatAbortCommand(
  [in]    RTECAT_COMMAND_STATUS Status
);

Parameters

[in] Status

The command to abort.

Return Values

The function returns an RTECAT_COMMAND_STATUS structure. If an error occurs, field State of the structure is set to ecatCommandError and the error code is stored in field ErrorId (see RTECAT_ERROR for error values). If the function succeeds, ErrorId is set to ecatErrNoError (which is represented by the value 0). If the function fails, it stores a different error value.

Possible return values:

Return value	Meaning
ecatErrNoError	The function succeeded.
ecatErrWrongParameter	The command is not active.
ecatErrMainDeviceNotReady	The MainDevice is not ready.

Remarks

RtecatAbortCommand doesn't return error codes for individual commands.

RtecatAbortCommand is an asynchronous function that takes time to complete. It allows for background execution and requires you to check its status by calling RtecatGetCommandStatus or wait for it to complete by calling RtecatWaitForCommand.

When simulated hardware is configured, calling RtecatAbortCommand to abort a running RtecatStart immediately launches with simulated hardware, even if real hardware is connected.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtecatApi.h	RtecatApi_W64.lib (Windows), RtecatApi.lib (RTSS)