IXtfFindFileCallback::OnFoundFile Method

Article
06/22/2023

Called when a file is found during a find or delete operation.

Syntax

public:
HRESULT OnFoundFile(
         LPCWSTR pszRootDirectory,
         LPCWSTR pszSearchPattern,
         LPCXTFFILEINFO pFileInfo
)

Parameters

pszRootDirectory
Type: LPCWSTR

Pointer to the root directory path for the operation.

pszSearchPattern
Type: LPCWSTR

Pointer to the search pattern that defines the filenames of the files for the operation.
This parameter accepts wildcard characters to match strings with the indicated pattern.

pFileInfo
Type: LPCXTFFILEINFO

Pointer to an XTFFILEINFO structure that contains information about the located file.

Return value

Type: HRESULT

HRESULT success or error code.

Remarks

This function is called every time that a file is found as the result of a call to the find or delete functions IXtfFileIOClient::FindFiles, and IXtfFileIOClient::DeleteFiles. This function will return information about each file found during the find or deletion process. Found information can be used to report progress on the requested file io occurring. Returning an error result from this callback function will abort the xtf IO operation with an error.

Requirements

Header: xtffileio.h

Library: xtffileio.lib

Supported platforms: Windows (for Xbox console tools)

Share via