Library.ForceModuleInputWord Method

Writes a word into an input buffer of a simulated module.

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 ForceModuleInputWord(
    EcatHandle module,
    uint byteOffset,
    ushort value
)

Parameters

module

Type: EcatHandle
A handle to a module. To retrieve the corresponding handle, use OpenModuleByIndex or OpenModuleByLocation.

byteOffset

Type: UInt32
A byte offset to the location to write a word.

value

Type: UInt16
A word to write into an input buffer of a simulated 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 module is invalid.
  • Parameter byteOffset is invalid.

ecatErrMainDeviceNotReady

The MainDevice is not ready.

ecatErrWrongEnvironment

One of the following conditions occurred:

  • The MainDevice has not started.
  • The module is not a simulated module.

See Also: