Api.GetCommandStatus method

Gets the state of a command.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

public KsCommandStatus GetCommandStatus(
       KsCommandStatus Status
)

Public Function GetCommandStatus(
       Status As KsCommandStatus
) As KsCommandStatus

Parameters

Status

Type: KsCommandStatus

The command you want to get its state. It can be filled with a command whose return type is KsCommandStatus class.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Remarks

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

Usable EtherCAT states

ecatOffline, ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A

See also

Api Class

IntervalZero.KINGSTAR.Local.Api Namespace