IXtfFileIOClient::DeleteFiles Method
Deletes files from the development console.
Syntax
public:
HRESULT DeleteFiles(
LPCWSTR pszSearchPattern,
DWORD dwIncludeAttributes,
DWORD dwExcludeAttributes,
DWORD dwRecursionLevels,
DWORD dwFlags,
IXtfFindFileCallback *pCallback
)
Parameters
pszSearchPattern
Type: LPCWSTR
Pointer to the search pattern that defines the filenames of the files to delete.
This parameter accepts wildcard characters to match strings with the indicated pattern.
dwIncludeAttributes
Type: DWORD
Bitwise-OR combination of file attributes to include for the delete. See File Attribute Constants for a list of possible attributes.
dwExcludeAttributes
Type: DWORD
Bitwise-OR combination of file attributes to exclude from the delete. See File Attribute Constants for a list of possible attributes.
dwRecursionLevels
Type: DWORD
Number of directory levels to recurse for the delete.
dwFlags
Type: DWORD
Flags that specify how to delete the files. This is a bitwise-OR combination of the macros listed in the following table.
| Value | Macro | Description |
|---|---|---|
| 0x80000000 | XTFDELETEFILE_DEFER | Defer the file deletion. |
pCallback
Type: IXtfFindFileCallback *
Pointer to the IXtfFindFileCallback callback to call when a file to delete is found.
Return value
Type: HRESULT
HRESULT success or error code.
Remarks
When deleting files dwIncludeAttributes and dwExcludeAttributes act as filters on which files are deleted, it does not act as a filter on which file attributes are deleted when deleting files. The IXtfFindFileCallback's onfindfile function call will be called for each file being deleted. The callback function will return information about each file being deleted. The returned information can be used to return progress information about the progress of deletion.
Requirements
Header: xtffileio.h
Library: xtffileio.lib
Supported platforms: Windows (for Xbox console tools)