IXtfCopyFileCallback::OnStartFileCopy Method
Called when a file starts copying between two locations on a development console.
Syntax
public:
HRESULT OnStartFileCopy(
LPCWSTR pszRootDirectory,
LPCWSTR pszSearchPattern,
LPCXTFFILEINFO pSrcFileInfo,
LPCWSTR pszDstFileName
)
Parameters
pszRootDirectory
Type: LPCWSTR
Pointer to the root directory path for the copy.
pszSearchPattern
Type: LPCWSTR
Pointer to the search pattern that defines the filenames of the source files to copy. This parameter accepts wildcard characters to match strings with the indicated pattern.
pSrcFileInfo
Type: LPCXTFFILEINFO
Pointer to an XTFFILEINFO structure that contains information about the file copied.
pszDstFileName
Type: LPCWSTR
Pointer to the filename of the target file.
Return value
Type: HRESULT
Returns S_OK if successful; otherwise, returns an HRESULT error code.
Remarks
This callback function is called once by the IXtfFileIOClient::CopyFiles method at the beginning of a file copying operation. The file size returned in the XTFFILEINFO structure represents the sum of the size of the files that needs to be copied, in bytes. You can use this sum to track overall progress of the file copying operation. If this callback function returns an HRESULT error code, the file copying operation is aborted.
Requirements
Header: xtffileio.h
Library: xtffileio.lib
Supported platforms: Windows (for Xbox console tools)