RtecatWriteAxisOutputBit

RtecatWriteAxisOutputBit writes a bit into an output buffer of an axis.

Syntax

Copy

RTECAT_ERROR RtecatWriteAxisOutputBit(
  [in]    RTECAT_HANDLE Axis,
  [in]    ULONG BitOffset,
  [in]    BOOL Value
);

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 write a bit value.

[in] Value

A BOOL value to write into an output 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.
ecatErrWrongParameter	Parameter Axis or BitOffset is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The link has not started.

Remarks

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