GetCommandStatus

Gets the state of a command.

Syntax

KsCommandStatus GetCommandStatus(
     KsCommandStatus Status
);

Parameters

Status: the command you want to get its state. 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 GetCommandStatus should not be empty, but be the return value of another command such as Start.
• It can be used to release a probe. After the probe is released, the Done flag in GetCommandStatus becomes TRUE.

Usable EtherCAT states

ecatOffline, ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP

Example

KsCommandStatus commandStop = Stop();
// Some operation in your application
commandStop = GetCommandStatus(commandStop);

Requirements

See also

AbortCommand

GetCommandsStatus

WaitForCommand