RtvdbGetDirectoryDisplayName

RtvdbGetDirectoryDisplayName gets the directory display name.

Syntax

Copy
DWORD RtvdbGetDirectoryDisplayName(
  [in]    RTVDB_DIRECTORY Directory,
  [in]    wchar_t* pDisplayName
);

Parameters

[in] Directory

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

[in] pDisplayName

A pointer to the buffer of the directory display name. The buffer length must be 64 characters.

Return Values

Error code Meaning

ERROR_SUCCESS

The function succeeded.

ERROR_INVALID_PARAMETER

Parameter Directory or pDisplayName is NULL.

ERROR_INVALID_HANDLE

One of the following conditions occurred:

  • Parameter Directory does not point to a directory or points to a closed directory.
  • Parameter Directory is a root directory.

ERROR_ABANDONED_WAIT_0

Failed to acquire the synchronization lock.

ERROR_NOT_READY

The calling process has not called RtvdbInitialize.

Requirements

Minimum supported version Header Library

wRTOS 1.1 SDK

RtvdbApi.h

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

See Also: