RtecatGetModuleBuffers

RtecatGetModuleBuffers provides pointers to the input and output buffers of a module.

Syntax

Copy

RTECAT_ERROR RtecatGetModuleBuffers(
  [in]    RTECAT_HANDLE Module,
  [out]   void** pInputBuffer,
  [out]   void** pOutputBuffer
);

Parameters

[in] Module

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

[out] pInputBuffer

A pointer to a void* variable where the input buffer pointer will be stored.

[out] pOutputBuffer

A pointer to a void* variable where the output buffer pointer will be stored.

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 pInputBuffer or pOutputBuffer is NULL.
ecatErrWrongParameter	Parameter Module is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The link has not started.

Remarks

RtecatGetModuleBuffers is only available for real-time interfaces.

RtecatGetModuleBuffers 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.lib