RtvdbOpenDatabase

RtvdbOpenDatabase opens a database and its root directory.

Syntax

Copy 
DWORD RtvdbOpenDatabase(
  [out]   RTVDB_DATABASE* pDatabase,
  [out]   RTVDB_DIRECTORY* pRootDirectory,
  [in]    const wchar_t* pName,
  [out]   ULONG* pSize
);

Parameters

[out] pDatabase

A pointer to store the database handle.

[out] pRootDirectory

A pointer to store the root directory handle.

[in] pName

The database name to open. The maximum name length is 63 characters, as defined by RTVDB_MAX_NAME_LENGTH in the header file.

[out] pSize

A pointer to store the maximum number of variables in the root directory.

Return Values

Error code Meaning

ERROR_SUCCESS

The function succeeded.

ERROR_NOT_READY

One of the following conditions occurred:

  • The calling process has not called RtvdbInitialize.
  • The database is currently invalidated.

ERROR_INVALID_PARAMETER

One of the following conditions occurred:

  • Parameter pDatabase, pRootDirectory, pName, or pSize is NULL.
  • The value of parameter pName is either empty or exceeds 63 characters in length.

ERROR_NOT_FOUND

There is no database with this name.

ERROR_ABANDONED_WAIT_0

Failed to acquire the synchronization lock.

ERROR_NOT_ENOUGH_MEMORY

Failed to allocate memory.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtvdbApi.h

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

See Also: