RtecatReadModuleInputByte
RtecatReadModuleInputByte reads a byte from an input buffer of a module.
Syntax
RTECAT_ERROR RtecatReadModuleInputByte(
[in] RTECAT_HANDLE Module,
[in] ULONG ByteOffset,
[out] BYTE* pValue
);Parameters
[in] Module
A handle to a module. To retrieve the corresponding handle, use RtecatOpenModuleByIndex or RtecatOpenModuleByLocation.
[in] ByteOffset
A byte offset to the location to read a BYTE value.
[out] pValue
A pointer to a variable that stores a BYTE 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 ByteOffset is invalid. |
|
ecatErrMainDeviceNotReady |
The MainDevice is not ready. |
|
ecatErrWrongEnvironment |
The link has not started. |
Remarks
RtecatReadModuleInputByte 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) |
See Also:
