AbortCommand

Cancels a command.

Syntax

KsCommandStatus AbortCommand(
     KsCommandStatus Status
);

Parameters

Status: the state of the command you want to abort. It can be filled with a command whose return type is KsCommandStatus, or a returned KsCommandStatus structure.

Return value

Returns the KsCommandStatus structure.

Remarks

The value given as Status to AbortCommand should not be empty, but be the return value of another command such as Start.

Usable EtherCAT states

ecatOffline, ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP

Example

Copy

KsCommandStatus commandToAbort = Start();
// Some operation in your application
commandToAbort = AbortCommand(commandToAbort);

Requirements

	RT	Win32
Minimum supported version	4.0	4.0
Header	ksapi.h	ksapi.h
Library	KsApi_Rtss.lib	KsApi.lib