CopyFileExW 関数 (winbase.h)
既存のファイルを新しいファイルにコピーし、コールバック関数を介してその進行状況をアプリケーションに通知します。
この操作をトランザクション操作として実行するには、CopyFileTransacted 関数を使用します。
構文
BOOL CopyFileExW(
[in] LPCWSTR lpExistingFileName,
[in] LPCWSTR lpNewFileName,
[in, optional] LPPROGRESS_ROUTINE lpProgressRoutine,
[in, optional] LPVOID lpData,
[in, optional] LPBOOL pbCancel,
[in] DWORD dwCopyFlags
);
パラメーター
[in] lpExistingFileName
既存のファイルの名前。
既定では、名前はMAX_PATH文字に制限されています。 この制限を 32,767 文字のワイド文字に拡張するには、パスの先頭に "\\?\" を付けます。 詳細については、「ファイル、パス、および名前空間の名前付け
先端
Windows 10 バージョン 1607 以降では、事前に "\\?\" なしでMAX_PATHの制限を削除することをオプトインできます。 詳細については、「名前付けファイル、パス、および名前空間の」の「パスの最大長制限」セクションを参照してください。
lpExistingFileName
[in] lpNewFileName
新しいファイルの名前。
既定では、名前はMAX_PATH文字に制限されています。 この制限を 32,767 文字のワイド文字に拡張するには、パスの先頭に "\\?\" を付けます。 詳細については、「ファイル、パス、および名前空間の名前付け
先端
Windows 10 バージョン 1607 以降では、事前に "\\?\" なしでMAX_PATHの制限を削除することをオプトインできます。 詳細については、「名前付けファイル、パス、および名前空間の」の「パスの最大長制限」セクションを参照してください。
[in, optional] lpProgressRoutine
ファイルの別の部分がコピーされるたびに呼び出される LPPROGRESS_ROUTINE 型のコールバック関数のアドレス。 このパラメーターは NULL
[in, optional] lpData
コールバック関数に渡される引数。 このパラメーターは NULL
[in, optional] pbCancel
このフラグがコピー操作中に TRUE
[in] dwCopyFlags
ファイルのコピー方法を指定するフラグ。 このパラメーターには、次の値の組み合わせを指定できます。
戻り値
関数が成功した場合、戻り値は 0 以外です。
関数が失敗した場合、戻り値は 0 です。 拡張エラー情報を取得するには、GetLastError
ユーザー
ユーザー
備考
この関数は、拡張属性、OLE 構造化ストレージ、NTFS ファイル システム代替データ ストリーム、セキュリティ リソース属性、およびファイル属性を保持します。
Windows 7、Windows Server 2008 R2、Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: 既存のファイルの セキュリティ リソース属性 (ATTRIBUTE_SECURITY_INFORMATION) は、Windows 8 および Windows Server 2012 まで新しいファイルにコピーされません。
既存のファイルのセキュリティ リソース プロパティ (ATTRIBUTE_SECURITY_INFORMATION) が新しいファイルにコピーされます。
Windows 7、Windows Server 2008 R2、Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: 既存のファイルの セキュリティ リソースプロパティは、Windows 8 および Windows Server 2012 まで新しいファイルにコピーされません。
この関数は、コピー先ファイルが既に存在し、FILE_ATTRIBUTE_HIDDEN または FILE_ATTRIBUTE_READONLY 属性が設定されている場合、ERROR_ACCESS_DENIED で失敗します。
CopyFileEx
COPY_FILE_COPY_SYMLINK を指定すると、次の規則が適用されます。
- ソース・ファイルがシンボリック・リンクの場合は、ターゲット・ファイルではなくシンボリック・リンクがコピーされます。
- ソース ファイルがシンボリック リンクでない場合、動作に変更はありません。
- 宛先ファイルが既存のシンボリック・リンクの場合、ターゲット・ファイルではなくシンボリック・リンクが上書きされます。
- COPY_FILE_FAIL_IF_EXISTS も指定され、宛先ファイルが既存のシンボリック リンクである場合、操作は失敗します。
- COPY_FILE_FAIL_IF_EXISTS も指定され、宛先ファイルが既存のシンボリック リンクである場合、シンボリック リンクのターゲットが存在する場合にのみ、操作は失敗します。
- COPY_FILE_FAIL_IF_EXISTS が指定されていない場合、動作に変更はありません。
Windows 7、Windows Server 2008 R2、Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: LAN 経由でファイルコピー操作を最適化するアプリケーションを作成する場合は、Windows ソケット (Winsock) の TransmitFile 関数の使用を検討してください。 TransmitFile は、高パフォーマンスのネットワーク転送をサポートし、ファイルの内容をリモート コンピューターに送信するための簡単なインターフェイスを提供します。 TransmitFileを使用するには、ソース コンピューターからファイルを送信する Winsock クライアント アプリケーションと、他の Winsock 関数を使用してリモート コンピューター上のファイルを受信する Winsock サーバー アプリケーションを記述する必要があります。
Windows 8 および Windows Server 2012 では、この関数は次のテクノロジでサポートされています。
| テクノロジー | サポート |
|---|---|
| サーバー メッセージ ブロック (SMB) 3.0 プロトコル | はい |
| SMB 3.0 透過的フェールオーバー (TFO) | はい |
| SMB 3.0 とスケールアウト ファイル共有 (SO) | はい |
| クラスター共有ボリューム ファイル システム (CsvFS) | はい |
| 回復性のあるファイル システム (ReFS) | はい |
手記
winbase.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして CopyFileEx を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
| 要件 | 価値 |
|---|---|
| サポートされる最小クライアント | Windows XP [デスクトップ アプリ |UWP アプリ] |
| サポートされる最小サーバー | Windows Server 2003 [デスクトップ アプリ |UWP アプリ] |
| ターゲット プラットフォーム の |
ウィンドウズ |
| ヘッダー | winbase.h (Windows.h を含む) |
| ライブラリ | Kernel32.lib |
| DLL | Kernel32.dll |
関連項目
CreateFile の
MoveFile の
MoveFileWithProgress の
シンボリック リンク の