RtecatReadModuleInputBit

RtecatReadModuleInputBit reads a bit from an input buffer of a module.

Syntax

Copy

RTECAT_ERROR RtecatReadModuleInputBit(
  [in]    RTECAT_HANDLE Module,
  [in]    ULONG BitOffset,
  [out]   BOOL* pValue
);

Parameters

[in] Module

A handle to a module. To retrieve the corresponding handle, use RtecatOpenModuleByIndex or RtecatOpenModuleByLocation.

[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 a module.

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 Module or BitOffset is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The link has not started.

Remarks

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