RtecatForceAxisInputWord

RtecatForceAxisInputWord writes a word into an input buffer of a simulated axis.

Syntax

Copy

RTECAT_ERROR RtecatForceAxisInputWord(
  [in]    RTECAT_HANDLE Axis,
  [in]    ULONG ByteOffset,
  [in]    WORD Value
);

Parameters

[in] Axis

A handle to an axis. To retrieve the corresponding handle, use RtecatOpenAxisByIndex or RtecatOpenAxisByLocation.

[in] ByteOffset

A byte offset to the location to write a WORD value.

[in] Value

A WORD value to write into an input buffer of a simulated axis.

Return Values

The function returns an RTECAT_ERROR value. If the function succeeds, it returns ecatErrNoError. If the function fails, it returns a different value.

Possible return values:

Return value	Meaning
ecatErrNoError	The function succeeded.
ecatErrWrongParameter	Parameter Axis or ByteOffset is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The link has not started, or the axis is not a simulated one.

Remarks

RtecatForceAxisInputWord is a synchronous function that executes immediately and returns a result upon completion.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtecatApi.h	RtecatApi_W64.lib (Windows), RtecatApi.lib (RTSS)