IApi.GetCommandsStatus method

Gets the states of commands.

Namespace: IntervalZero.KINGSTAR.Base.Api

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

Syntax

KsReturn<KsCommandStatus<byte[]>[]> GetCommandsStatus(
       KsCommandStatus<byte[]>[] Statuses
)

Function GetCommandsStatus(
       Statuses As KsCommandStatus(Of Byte())()
) As KsReturn(Of KsCommandStatus(Of Byte())())

Parameters

Statuses

Type: KsCommandStatus<byte[]>

The array of commands you want to get their states. You can use the constructor from KsCommandStatus<T> to create a KsCommandStatus<byte[]> command and pass the array of commands to the function.

Return value

Type: KsReturn<KsCommandStatus<byte[]>[]>

Returns the KsReturn<T> class which contains ErrorId and Value. The ErrorId contains error code from the function; while the Value contains the status of command array.

Remarks

The value given as Statuses to GetCommandsStatus should not be empty, but be the return value of another command such as Start.
If GetCommandsStatus is used in Win32 and .NET interface, one command's ValueLength (KsCommandStatus) can't be longer than 8 bytes.

Usable EtherCAT states

ecatOffline, ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A