RtvdbCloseDirectory

RtvdbCloseDirectory closes a directory.

Syntax

Copy

DWORD RtvdbCloseDirectory(
  [in]    RTVDB_DIRECTORY Directory,
  [in]    BOOL ForceClose
);

Parameters

[in] Directory

A handle for the directory to close. To retrieve the corresponding handle, use RtvdbOpenDirectory.

[in] ForceClose

TRUE to automatically close any opened handles under this directory, FALSE to fail the function. See Remarks for more details.

Return Values

Error code	Meaning
ERROR_SUCCESS	The function succeeded.
ERROR_INVALID_PARAMETER	One of the following conditions occurred: Parameter Directory is NULL. Parameter Directory is a database root directory.
ERROR_INVALID_HANDLE	Parameter Directory does not point to a directory or points to a closed directory.
ERROR_OPERATION_ABORTED	One of the following conditions occurred: Handles are still opened and ForceClose is FALSE. The directory is still opened when this error is returned.
ERROR_ABANDONED_WAIT_0	Failed to acquire the synchronization lock.
ERROR_NOT_READY	The calling process has not called RtvdbInitialize.

Remarks

If any handles remain open within the application and ForceClose is set to FALSE, the call will fail, and the directory will remain open.
This function can't be used for root directories as they are tied to the database.

Requirements

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