IXtfFileIOClient::RemoveDirectory Method

2025-04-28

Deletes the specified directory from the development console.

Syntax

public:
HRESULT RemoveDirectory(
         LPCWSTR pszDirectory,
         DWORD dwFlags,
         IXtfFindFileCallback *pCallback
)

Parameters

pszDirectory
Type: LPCWSTR

Pointer to the directory path to the directory to delete from the development console.

dwFlags
Type: DWORD

Flags that specify how to delete the directory. This is a bitwise-OR combination of the macros listed in the following table.

Value	Macro	Description
0x1	XTFREMOVEDIRECTORY_FORCE	Forces the directory deletion to occur, even if the directory contains files or subdirectories.
0x80000000	XTFDELETEFILE_DEFER	Defers the directory deletion.

pCallback
Type: IXtfFindFileCallback*

Pointer to the IXtfFindFileCallback callback to call when a directory to delete is found.

Return value

Type: HRESULT

Returns S_OK if successful; otherwise, returns an HRESULT error code.

Remarks

This function removes a directory on the development console. If an error occurs, this function returns an HRESULT error code. For more information about HRESULT error codes specific to Xbox Tools Framework (XTF) API, see XTF transport errors (NDA topic)Authorization required.

If XTFREMOVEDIRECTORY_FORCE is specified and the directory to be removed contains files or subdirectories, the IXtfFindFileCallback::OnFoundFile callback function is invoked for each file and subdirectory in the directory to be removed. Information for each file and subdirectory in the directory is passed to the callback function, and that information can be used to track and display progress information.

Requirements

Header: xtffileio.h

Library: xtffileio.lib

Supported platforms: Windows (for Xbox console tools)

Share via