RtecatForceModuleInputBit

RtecatForceModuleInputBit writes a bit into an input buffer of a simulated module.

Syntax

Copy

RTECAT_ERROR RtecatForceModuleInputBit(
  [in]    RTECAT_HANDLE Module,
  [in]    ULONG BitOffset,
  [in]    BOOL Value
);

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

[in] Value

A BOOL value to write into an input buffer of a simulated 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.
ecatErrWrongParameter	Parameter Module or BitOffset is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	One of the following conditions occurred: The link has not started. The module is not a simulated module.

Remarks

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