IXtfCopyFileCallback::OnStartFileCopy メソッド

開発本体上の 2 つの場所の間でのファイルのコピーが開始すると呼び出されます。

構文

public:
HRESULT OnStartFileCopy(
         LPCWSTR pszRootDirectory,
         LPCWSTR pszSearchPattern,
         LPCXTFFILEINFO pSrcFileInfo,
         LPCWSTR pszDstFileName
)  

パラメーター

pszRootDirectory
型: LPCWSTR

コピーのルート ディレクトリ パスへのポインター。

pszSearchPattern
型: LPCWSTR

コピーするソース ファイルのファイル名を定義する検索パターンへのポインター。 このパラメーターは、指定されたパターンの文字列に一致するワイルドカード文字を受け入れます。

pSrcFileInfo
型: LPCXTFFILEINFO

コピーされるファイルに関する情報を含む XTFFILEINFO 構造体へのポインター。

pszDstFileName
型: LPCWSTR

対象ファイルのファイル名へのポインター。

戻り値

型: HRESULT

正常に実行された場合は S_OK を返し、失敗した場合は HRESULT エラー コードを返します。

解説

このコールバック関数は、ファイル コピー操作の開始時に IXtfFileIOClient::CopyFiles メソッドによって 1 回呼び出されます。 XTFFILEINFO 構造体で返されるファイル サイズは、コピーする必要があるファイルのサイズの合計をバイト単位で表します。 この合計を使用して、ファイル コピー操作の全体的な進行状況を追跡できます。 このコールバック関数が HRESULT エラー コードを返す場合、ファイル コピー操作は中止されます。

要件

ヘッダー: xtffileio.h

ライブラリ: xtffileio.lib

サポートされているプラットフォーム: Windows (Xbox 本体ツール用)

関連項目

IXtfCopyFileCallback インターフェイス
XtfFileIO