IXtfBatchFileIOClient::CopyFiles Method

Article
06/22/2023

Batch-copies files enumerated in a list of strings between two locations on a development console and returns information about the operation.

Note

This method is deprecated. Use the IXtfFileIOClient::CopyFiles method instead.

Syntax

public:
HRESULT CopyFiles(
         LPCWSTR pszRootDirectory,
         LPCWSTR *rgszRootDirectoryRelativeFiles,
         DWORD cRootDirectoryRelativeFiles,
         LPCWSTR pszDstDirectoryName,
         DWORD dwFlags,
         IXtfCopyFileCallback *pCallback
)

Parameters

pszRootDirectory
Type: LPCWSTR

A pointer to the root directory for the batch copy.

rgszRootDirectoryRelativeFiles
Type: LPCWSTR*

A pointer to a list of strings which contains the names of the files to be copied.

cRootDirectoryRelativeFiles
Type: DWORD

The number of files for the batch copy.

pszDstDirectoryName
Type: LPCWSTR

A pointer to the destination directory name for the batch copy.

dwFlags
Type: DWORD

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

Value	Macro	Description
0x80000000	XTFCOPYFILE_DEFER	Defer the file copy.

pCallback
Type: IXtfCopyFileCallback*

Pointer to the IXtfCopyFileCallback callback to call when the status of the copy changes.

Return value

Type: HRESULT

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

Remarks

This function copies files enumerated in a list of strings between two locations on a development console as a batch operation and returns information about the operation.

Note

This method is deprecated. Use the IXtfFileIOClient::CopyFiles method instead.

Requirements

Header: xtffileio.h

Library: xtffileio.lib

Supported platforms: Windows (for Xbox console tools)

Partager via