RtvdbCreateDirectory

RtvdbCreateDirectory creates and opens a sub-directory.

Syntax

Copy 
DWORD RtvdbCreateDirectory(
  [in]    RTVDB_DIRECTORY Parent,
  [out]   RTVDB_DIRECTORY* pDirectory,
  [in]    const wchar_t* pName,
  [in]    ULONG Size
);

Parameters

[in] Parent

A handle of the parent directory. To retrieve the corresponding handle, use RtvdbOpenDirectory, RtvdbOpenDatabase, RtvdbCreateDirectory, or RtvdbCreateDatabase.

[out] pDirectory

A pointer to store the opened directory handle. See RTVDB_DIRECTORY.

[in] pName

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

[in] Size

The maximum number of variables that can be added to this 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 Parent, pDirectory, or pName is NULL.
  • The value of parameter pName is either empty or exceeds 63 characters in length.
  • The value of parameter Size is zero (0).

ERROR_ALREADY_EXISTS

A directory with this name already exists in the parent directory.

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: