RtvdbBrowseDatabases

RtvdbBrowseDatabases gets the list of databases.

Syntax

Copy

DWORD RtvdbBrowseDatabases(
  [in]    ULONG BufferSize,
  [out]   ULONG* pLength,
  [out]   RTVDB_DATABASE_DESCRIPTION* pDatabases
);

Parameters

[in] BufferSize

The number of database descriptions that can be copied to pDatabases.

[out] pLength

The number of databases.

[out] pDatabases

A pointer to the database descriptions buffer.

Return Values

Error code	Meaning
ERROR_SUCCESS	The function succeeded.
ERROR_INVALID_PARAMETER	One of the following conditions occurred: Parameter pLength is NULL. Parameter pDatabases is NULL and parameter BufferSize is greater than zero.
ERROR_NOT_READY	The calling process has not called RtvdbInitialize.

Error code

Meaning

ERROR_SUCCESS

The function succeeded.

ERROR_INVALID_PARAMETER

One of the following conditions occurred:

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)