RtvdbGetLogStatus

RtvdbGetLogStatus gets the current log status.

Syntax

Copy
DWORD RtvdbGetLogStatus(
  [out]            RTVDB_LOG_STATUS* pStatus,
  [out, optional]  ULONG* pBufferSize,
  [out, optional]  ULONG* pCurrentIndex
);

Parameters

[out] pStatus

A pointer to the status of the log.

[out, optional] pBufferSize

A pointer to the size of the log data shared memory.

[out, optional] pCurrentIndex

A pointer to the index for the next logged value.

Return Values

Error code Meaning

ERROR_SUCCESS

The function succeeded.

ERROR_NOT_READY

The calling process has not called RtvdbInitialize.

ERROR_INVALID_PARAMETER

Parameter pStatus is NULL.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtvdbApi.h

RtvdbApi_W64.lib (Windows), RtvdbApi.lib (RTSS)

See Also: