IApi.WriteAxisSdoObject method

Writes the value of an SDO object into an axis.

Namespace: IntervalZero.KINGSTAR.Base.Api

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

Syntax

C#VB
KsCommandStatus WriteAxisSdoObject(
       int Index,
       int ObIndex,
       int ObSubIndex,
       bool CompleteAccess,
       byte[] Value
)
Function WriteAxisSdoObject(
       Index As Integer,
       ObIndex As Integer,
       ObSubIndex As Integer,
       CompleteAccess As Boolean,
       Value As Byte()
) As KsCommandStatus

Parameters

Index

Type: int

The index of an axis. 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: Writes all subindexes. FALSE: Writes a single subindex.

 

Value

Type: byte[]

Pointer to the buffer containing the data to be written into the object.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Usable EtherCAT states

ecatOP

Examples

C#
N/A

See also

IApi Interface

IntervalZero.KINGSTAR.Base.Api Namespace