> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# IXtfCopyFileCallback::OnStartFileCopy Method

> IXtfCopyFileCallback::OnStartFileCopy Method

# IXtfCopyFileCallback::OnStartFileCopy Method

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

<a id="syntaxSection" />

## 構文

```cpp theme={null}
public:
HRESULT OnStartFileCopy(
         LPCWSTR pszRootDirectory,
         LPCWSTR pszSearchPattern,
         LPCXTFFILEINFO pSrcFileInfo,
         LPCWSTR pszDstFileName
)  
```

<a id="parametersSection" />

### パラメーター

*pszRootDirectory*\
型: LPCWSTR

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

*pszSearchPattern*\
型: LPCWSTR

コピー対象となるソース ファイルのファイル名を定義する検索パターンへのポインターです。このパラメーターはワイルドカード文字を受け付け、指定したパターンで文字列を照合します。

*pSrcFileInfo*\
型: LPCXTFFILEINFO

コピーされたファイルに関する情報を含む [XTFFILEINFO](/reference/tools/xtf/xtffileio/structures/xtffileinfo-xtffileio-xbox-microsoft-t) 構造体へのポインターです。

*pszDstFileName*\
型: LPCWSTR

コピー先ファイルのファイル名へのポインターです。

<a id="retvalSection" />

### 戻り値

型: HRESULT

成功した場合は `S_OK` を返します。それ以外の場合は HRESULT エラー コードを返します。

<a id="remarksSection" />

## 解説

このコールバック関数は、ファイル コピー操作の開始時に [IXtfFileIOClient::CopyFiles](/reference/tools/xtf/xtffileio/classes/IXtfFileIOClient/methods/copyfiles-ixtffileioclient-xtffileio-xbox-microsoft-m) メソッドによって 1 回呼び出されます。[XTFFILEINFO](/reference/tools/xtf/xtffileio/structures/xtffileinfo-xtffileio-xbox-microsoft-t) 構造体で返されるファイル サイズは、コピーする必要のあるファイル群のサイズの合計 (バイト単位) を表します。この合計を使用して、ファイル コピー操作全体の進行状況を追跡できます。このコールバック関数が HRESULT エラー コードを返した場合、ファイル コピー操作は中止されます。

<a id="requirementsSection" />

## 要件

**ヘッダー:** xtffileio.h

**ライブラリ:** xtffileio.lib

**サポートされるプラットフォーム:** Windows (XBOX コンソール ツール用)

<a id="seealsoSection" />

## 関連項目

[IXtfCopyFileCallback Interface](/reference/tools/xtf/xtffileio/classes/IXtfCopyFileCallback/ixtfcopyfilecallback-xtffileio-xbox-microsoft-t)\
[XtfFileIO](/reference/tools/xtf/xtffileio/xtffileio-xbox-microsoft-n)


## Related topics

- [IXtfCopyFileCallback::OnEndFileCopy Method](/ja-jp/reference/tools/xtf/xtffileio/classes/IXtfCopyFileCallback/methods/onendfilecopy-ixtfcopyfilecallback-xtffileio-xbox-microsoft-m.md)
- [IXtfCopyFileCallback::OnFileCopyProgress Method](/ja-jp/reference/tools/xtf/xtffileio/classes/IXtfCopyFileCallback/methods/onfilecopyprogress-ixtfcopyfilecallback-xtffileio-xbox-microsoft-m.md)
- [IXtfBatchFileIOClient::CopyFiles Method](/ja-jp/reference/tools/xtf/xtffileio/classes/IXtfBatchFileIOClient/methods/copyfiles-ixtfbatchfileioclient-xtffileio-xbox-microsoft-m.md)
- [XTFFILEINFO](/ja-jp/reference/tools/xtf/xtffileio/structures/xtffileinfo-xtffileio-xbox-microsoft-t.md)
- [IXtfFileIOClient::CopyFiles メソッド](/ja-jp/reference/tools/xtf/xtffileio/classes/IXtfFileIOClient/methods/copyfiles-ixtffileioclient-xtffileio-xbox-microsoft-m.md)