RtvdbRenameDirectory

RtvdbRenameDirectory renames a directory.

Syntax

Copy

DWORD RtvdbRenameDirectory(
  [in]    RTVDB_DIRECTORY Directory,
  [in]    const wchar_t* pName
);

Parameters

[in] Directory

The handle for the directory to rename. To retrieve the corresponding handle, use RtvdbOpenDirectory or RtvdbCreateDirectory.

[in] pName

The new directory name. The maximum name length is 63 characters, as defined by RTVDB_MAX_NAME_LENGTH in the header file.

Return Values

Error code	Meaning
ERROR_SUCCESS	The function succeeded.
ERROR_INVALID_PARAMETER	One of the following conditions occurred: Parameter Directory or pName is NULL. The value of parameter pName is either empty or exceeds 63 characters in length.
ERROR_ALREADY_EXISTS	A directory with this name already exists in the parent directory.
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.0 SDK	RtvdbApi.h	RtvdbApi_W64.lib (Windows), RtvdbApi.lib (RTSS)