IApi.ConfigureIo method

Configures the settings of a simulated I/O module.

Namespace: IntervalZero.KINGSTAR.Base.Api

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

Syntax

KsError ConfigureIo(
       int Index,
       SlaveStatus Details
)

Function ConfigureIo(
       Index As Integer,
       Details As SlaveStatus
) As KsError

Parameters

Index

Type: int

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

Details

Type: SlaveStatus

Detailed information about the module. Before using this method, InputLength and OutputLength in the SlaveStatus class must be filled in. The default value is zero if no value is set.

Return value

Type: KsError

A return code of a method.

Remarks

Allows for simulation of expected behavior when using a simulated I/O module.

Usable EtherCAT states

ecatOffline, ecatOP

Examples

N/A