Library.AbortCommand (CommandStatus<SdoEntryDescription>) Method

Aborts a CommandStatus<SdoEntryDescription> type command.

Namespace: IntervalZero.MaxRT.Ecat.Api.NetApi
Assembly: IntervalZero.MaxRT.Ecat (in IntervalZero.MaxRT.Ecat.dll) Version: 1.0.0.0 (File version: 1.0.1)

Syntax

Copy

public CommandStatus<SdoEntryDescription> AbortCommand(
    CommandStatus<SdoEntryDescription> status
)

Parameters

status

Type: CommandStatus<SdoEntryDescription>
The command to abort.

Return Value

This method returns a CommandStatus class. If an error occurs, property State in CommandStatus is set to ecatCommandError, and the error code is stored in property ErrorId.

Possible errors:

Error code	Meaning
ecatErrNoError	The function succeeded.
ecatErrWrongParameter	The command is not active.
ecatErrMainDeviceNotReady	The MainDevice is not ready.