IFsiDirectoryItem::RemoveTree method (imapi2fs.h)

Article
10/13/2021

Remove the specified directory tree from the file system image.

Syntax

HRESULT RemoveTree(
  [in] BSTR path
);

Parameters

[in] path

String that contains the name of directory to remove. The path is relative to current directory item.

Return value

S_OK is returned on success, but other success codes may be returned as a result of implementation. The following error codes are commonly returned on operation failure, but do not represent the only possible error values:

Return code	Description
E_POINTER	The path parameter is not a valid pointer.
IMAPI_E_INVALID_PARAM	The value specified for parameter %1!ls! is not valid. Value: 0xC0AAB101
IMAPI_E_INVALID_PATH	Path '%1!s!' is badly formed or contains invalid characters. Value: 0xC0AAB110
IMAPI_E_NOT_IN_FILE_SYSTEM	ls!' is not part of the file system. It must be added to complete this operation. Value: 0xC0AAB10B
IMAPI_E_READONLY	FileSystemImage object is in read only mode. Value: 0xC0AAB102
IMAPI_E_DIR_NOT_FOUND	The specified directory does not exist.
IMAPI_E_DIR_NOT_EMPTY	The directory %1!s! is not empty. Value: 0xC0AAB10A
IMAPI_E_FSI_INTERNAL_ERROR	Internal error occurred: %1!ls!. Value: 0xC0AAB100
IMAPI_E_NOT_DIR	Specified path %1!ls! does not identify a directory. Value: 0xC0AAB109

Remarks

The directory item must be present in the file system image.

You can delete the entire file-system image by calling this method for the root directory item and setting the path to a single path delimiter (\).

Requirements

Requirement	Value
Minimum supported client	Windows Vista, Windows XP with SP2 [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	imapi2fs.h