RtvdbStartLog

RtvdbStartLog sends a request to start the log.

Syntax

Copy 
DWORD RtvdbStartLog(
  [in]    ULONG ChannelCount,
  [in]    RTVDB_CHANNEL* pChannels,
  [in]    RTVDB_TRIGGER Trigger,
  [in]    double Duration,
  [in]    ULONG LoggerChannel
);

Parameters

[in] ChannelCount

The number of channels to log. The maximum number of channels is 8, as defined by RTVDB_MAX_CHANNEL in the header file. You can also use RTVDB_MAX_CHANNEL to calculate the size of a data point.

[in] pChannels

A pointer to the channels.

[in] Trigger

A trigger to start the log.

[in] Duration

The duration, in seconds, of the log.

[in] LoggerChannel

The channel to synchronize the value collection.

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:

  • The value of parameter ChannelCount is zero (0).
  • Parameter pChannels is NULL.
  • Parameter pChannels includes an invalid buffer access.

ERROR_INVALID_HANDLE

Parameter pChannels includes a closed variable.

ERROR_ABANDONED_WAIT_0

Failed to acquire the synchronization lock.

ERROR_ALREADY_EXISTS

A log is already requested.

Remarks

The RtvdbStartLog function is deterministic.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtvdbApi.h

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

See Also: