Api.ReadIOSdoObject method

Reads a value of an SDO object from an I/O module.

Namespace: IntervalZero.KINGSTAR.Local.Api

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

Syntax

C#VB

public KsCommandStatus<byte[]> ReadIOSdoObject(
       int Index,
       int ObIndex,
       int ObSubIndex,
       bool CompleteAccess,
       int Length
)

Public Function ReadIOSdoObject(
       Index As Integer,
       ObIndex As Integer,
       ObSubIndex As Integer,
       CompleteAccess As Boolean,
       Length As Integer
) As KsCommandStatus(Of Byte())

Parameters

Index

Type: int

The index of an I/O module. Indexes are zero based. Aliases affect this parameter.

ObIndex

Type: int

The index of the object. See your device manual to get the value.

ObSubIndex

Type: int

The subindex of the object. See your device manual to get the value.

CompleteAccess

Type: bool

TRUE: Reads all subindexes. FALSE: Reads a single subindex.

Length

Type: int

The length in byte of the value to read.

Return value

Type: KsCommandStatus<byte[]>

Returns a state of a method and a byte array.

Usable EtherCAT states

ecatOP

Examples

N/A