RtvdbLogCyclicProcess

RtvdbLogCyclicProcess triggers the data-logging engine's cyclic process. The real-time application's cyclic task calls this function to trigger data collection synchronized with its process.

Syntax

Copy

DWORD RtvdbLogCyclicProcess(
  [in]    RTVDB_DATABASE Database,
  [in]    ULONG PeriodUs
);

Parameters

[in] Database

A database reference to compare with the selected logger channel.

[in] PeriodUs

The duration, in microseconds, between two calls to this function.

Return Values

Error code	Meaning
ERROR_SUCCESS	The function succeeded.
ERROR_NOT_READY	The calling process has not called RtvdbInitialize.
ERROR_INVALID_PARAMETER	One of the following conditions occurred: Parameter Database is NULL. The value of parameter PeriodUs is zero (0).
ERROR_INVALID_HANDLE	Parameter Database points to a closed database.
ERROR_INVALID_ENVIRONMENT	The function is called from a non-real-time application.

Remarks

The RtvdbLogCyclicProcess function is deterministic.

RtvdbLogCyclicProcess must be called by the cyclic process of real-time applications that create databases to allow synchronized logging.

Requirements

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