RtvdbBrowseDirectory

RtvdbBrowseDirectory browses a directory.

Syntax

Copy

DWORD RtvdbBrowseDirectory(
  [in]    RTVDB_DIRECTORY Directory,
  [in]    ULONG BufferSize,
  [out]   ULONG* pLength,
  [out]   RTVDB_VARIABLE_DESCRIPTION* pVariables
);

Parameters

[in] Directory

A handle of the directory to browse. To retrieve the corresponding handle, use RtvdbOpenDirectory or RtvdbOpenDatabase.

[in] BufferSize

The number of variable descriptions that can be copied to pVariables.

[out] pLength

The number of variables.

[out] pVariables

A pointer to the variable description buffer.

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 pLength or Directory is NULL. Parameter pVariables is NULL and parameter BufferSize is greater than zero.
ERROR_INVALID_HANDLE	Parameter Directory does not point to a directory or points to a closed directory.

Requirements

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