RtecatReadAxisInputDWord

RtecatReadAxisInputDWord reads a double word from an input buffer of an axis.

Syntax

Copy

RTECAT_ERROR RtecatReadAxisInputDWord(
  [in]    RTECAT_HANDLE Axis,
  [in]    ULONG ByteOffset,
  [out]   DWORD* pValue
);

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 read a DWORD value.

[out] pValue

A pointer to a variable that stores a DWORD from an input buffer of an 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.
ecatErrNullParameter	Parameter pValue is NULL.
ecatErrWrongParameter	Parameter Axis or ByteOffset is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The link has not started.

Remarks

RtecatReadAxisInputDWord 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)