RtvdbGetDatabaseStatus

RtvdbGetDatabaseStatus gets the status of a database.

Syntax

Copy
DWORD RtvdbGetDatabaseStatus(
  [in]    RTVDB_DATABASE Database,
  [out]   BOOL* pInvalidated,
  [out]   LONGLONG* pTimeStamp
);

Parameters

[in] Database

A handle for the database to get the status. To retrieve the corresponding handle, use RtvdbOpenDatabase or RtvdbCreateDatabase.

[out] pInvalidated

A pointer to check if objects are being removed from the database.

[out] pTimeStamp

A pointer to the database's last modified time, which is returned as GetClockTime.

Return Values

Error code Meaning

ERROR_SUCCESS

The function succeeded.

ERROR_INVALID_PARAMETER

Parameter Database, pInvalidated, or pTimeStamp is NULL.

ERROR_INVALID_HANDLE

Parameter Database does not point to a database or points to a closed database.

ERROR_NOT_READY

The calling process has not called RtvdbInitialize.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtvdbApi.h

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

See Also: