RtvdbGetLogData

RtvdbGetLogData reads the logged data, automatically wrapping around the end of the data logger buffer. It stops when reaching the current log index. This function also reads data points. Each point has a value for each channel.

Syntax

Copy

DWORD RtvdbGetLogData(
  [in]              ULONG BufferSize,
  [out]             RTVDB_POINT* pBuffer,
  [in]              ULONG StartIndex,
  [out]             ULONG* pReadLength,
  [out, optional]   LONGLONG* pTimeStamp,
  [out, optional]   ULONG* pPeriodUs
);

Parameters

[in] BufferSize

The size, in data points, of the buffer receiving the data.

[out] pBuffer

A pointer to the buffer receiving the data points.

[in] StartIndex

The index of the first point to log.

[out] pReadLength

A pointer to receive the number of points copied.

[out, optional] pTimeStamp

A pointer to receive the time stamp of the first point returned.

[out, optional] pPeriodUs

A pointer to receive the period, in microseconds, between points.

Return Values

Error code	Meaning
ERROR_SUCCESS	The function succeeded.
ERROR_NOT_READY	The calling process has not called RtvdbInitialize.
ERROR_INVALID_PARAMETER	Parameter pBuffer or pReadLength is NULL.

Remarks

The RtvdbGetLogData function is deterministic.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtvdbApi.h	RtvdbApi_W64.lib (Windows), RtvdbApi.lib (RTSS)