Library.ReadAxisInputWord Method

Reads a word from the input buffer of an axis.

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 ReadAxisInputWord(
    EcatHandle axis,
    uint byteOffset,
    ref ushort value
)

Parameters

axis

Type: EcatHandle
A handle to an axis. To retrieve the corresponding handle, use OpenAxisByIndex or OpenAxisByLocation.

byteOffset

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

value

Type: UInt16
A reference to a variable that receives a word from the input buffer of an axis.

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 axis is invalid.
  • Parameter byteOffset is invalid.

ecatErrMainDeviceNotReady

The MainDevice is not ready.

ecatErrWrongEnvironment

The MainDevice has not started.

See Also: