RtecatReadAxisInputBit

RtecatReadAxisInputBit reads a bit from an input buffer of an axis.

Syntax

Copy

RTECAT_ERROR RtecatReadAxisInputBit(
  [in]    RTECAT_HANDLE Axis,
  [in]    ULONG BitOffset,
  [out]   BOOL* pValue
);

Parameters

[in] Axis

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

[in] BitOffset

A bit offset to the location to read a bit value.

[out] pValue

A pointer to a variable that stores a bit 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 BitOffset is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The link has not started.

Remarks

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