Library.ForceAxisInputByte Method

Writes a byte value into an input buffer of a simulated axis.

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

Syntax

Copy 
public EcatErrorCode ForceAxisInputByte(
    EcatHandle axis,
    uint byteOffset,
    byte 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 write a byte value.

value

Type: Byte
A byte value to write into an input buffer of a simulated 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

One of the following conditions occurred:

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

See Also: