Library.ConfigureIo Method

Configures an I/O module. If the corresponding index contains a real I/O module, the configuration set will be overridden.

Namespace:  IntervalZero.MaxRT.Ecat.Api.NetApi
Assembly:  IntervalZero.MaxRT.Ecat (in IntervalZero.MaxRT.Ecat.dll) Version: 1.0.0.0 (File version: 1.0.1)

Syntax

Copy
public EcatErrorCode ConfigureIo(
    EcatHandle mainDevice,
    uint index,
    SubDeviceStatus details
)

Parameters

mainDevice

Type: EcatHandle
A handle to a MainDevice. To retrieve the corresponding handle, use CreateMainDevice or OpenMainDevice.

index

Type: UInt32
The index of an I/O module.

details

Type: SubDeviceStatus
The configuration details to be applied to the I/O module.

Return Value

EcatErrorCode is thrown when any of these errors occur:

Error code Meaning

ecatErrNoError

The function succeeded.

ecatErrWrongParameter

One of the following conditions occurred:

  • Parameter mainDevice is invalid.
  • Parameter index exceeds the configured number of I/O modules.

ecatErrMainDeviceNotReady

The MainDevice instance does not exist.

ecatErrWrongEnvironment

The MainDevice is not stopped. Calling this API after Library.Start is unsupported.

See Also: