ReplaceFileA 関数 (winbase.h)
1 つのファイルを別のファイルに置き換え、元のファイルのバックアップ コピーを作成するオプションで置き換えます。 置換ファイルは、置き換えられたファイルの名前とその ID を前提としています。
構文
BOOL ReplaceFileA(
[in] LPCSTR lpReplacedFileName,
[in] LPCSTR lpReplacementFileName,
[in, optional] LPCSTR lpBackupFileName,
[in] DWORD dwReplaceFlags,
LPVOID lpExclude,
LPVOID lpReserved
);
パラメーター
[in] lpReplacedFileName
置き換えるファイルの名前。
既定では、名前はMAX_PATH文字に制限されています。 この制限を 32,767 文字のワイド文字に拡張するには、パスの先頭に "\\?\" を付けます。 詳細については、「ファイル、パス、および名前空間の名前付け
先端
Windows 10 バージョン 1607 以降では、事前に "\\?\" なしでMAX_PATHの制限を削除することをオプトインできます。 詳細については、「名前付けファイル、パス、および名前空間の」の「パスの最大長制限」セクションを参照してください。
このファイルは、
呼び出し元は、置き換えるファイルへの書き込みアクセス権を持っている必要があります。 詳細については、「ファイルのセキュリティとアクセス権の」を参照してください。
[in] lpReplacementFileName
lpReplacedFileName ファイルを置き換えるファイルの名前。
既定では、名前はMAX_PATH文字に制限されています。 この制限を 32,767 文字のワイド文字に拡張するには、パスの先頭に "\\?\" を付けます。 詳細については、「ファイル、パス、および名前空間の名前付け
先端
Windows 10 バージョン 1607 以降では、事前に "\\?\" なしでMAX_PATHの制限を削除することをオプトインできます。 詳細については、「名前付けファイル、パス、および名前空間の」の「パスの最大長制限」セクションを参照してください。
この関数は、すべての属性と ACL を保持できるように、SYNCHRONIZE、GENERIC_READ、GENERIC_WRITE、DELETE、WRITE_DAC アクセス権を使用してこのファイルを開こうとします。 これが失敗した場合、関数は、SYNCHRONIZE、GENERIC_READ、DELETE、および WRITE_DAC アクセス権を使用してファイルを開こうとします。 共有モードは指定されません。
[in, optional] lpBackupFileName
lpReplacedFileName ファイルのバックアップ コピーとして機能するファイルの名前。 このパラメーターが NULL
既定では、名前はMAX_PATH文字に制限されています。 この制限を 32,767 文字のワイド文字に拡張するには、パスの先頭に "\\?\" を付けます。 詳細については、「ファイル、パス、および名前空間の名前付け
先端
Windows 10 バージョン 1607 以降では、事前に "\\?\" なしでMAX_PATHの制限を削除することをオプトインできます。 詳細については、「名前付けファイル、パス、および名前空間の」の「パスの最大長制限」セクションを参照してください。
[in] dwReplaceFlags
置換オプション。 このパラメーターには、次の値のうち 1 つ以上を指定できます。
lpExclude
将来の使用のために予約されています。
lpReserved
将来の使用のために予約されています。
戻り値
関数が成功した場合、戻り値は 0 以外です。
関数が失敗した場合、戻り値は 0 です。 拡張エラー情報を取得するには、GetLastError
| 戻りコード/値 | 形容 |
|---|---|
|
置換ファイルの名前を変更できませんでした。 lpBackupFileName |
|
置換ファイルを移動できませんでした。 置換ファイルは元の名前の下に引き続き存在します。ただし、置き換えるファイルからファイル ストリームと属性を継承しています。 置き換えるファイルは、まだ別の名前で存在します。 lpBackupFileName |
|
置き換えられたファイルを削除できませんでした。 置き換えられたファイルと置換されたファイルは、元のファイル名を保持します。 |
ERROR_INVALID_PARAMETERなど、他のエラーが返された場合、置換されたファイルと置換されたファイルは元のファイル名を保持します。 このシナリオでは、バックアップ ファイルは存在せず、置き換えられたファイルのすべての属性とストリームが置換ファイルによって継承されるとは限りません。
備考
- 作成時刻
- 短いファイル名
- オブジェクト識別子
- DACL
- セキュリティ リソース属性
- 暗号化
- 圧縮
- 置換ファイルに名前付きストリームがまだ含まれていない
Windows 7、Windows Server 2008 R2、Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: 元のファイルの セキュリティ リソース属性 (ATTRIBUTE_SECURITY_INFORMATION) は、Windows 8 および Windows Server 2012 まで保持されません。
置換ファイルが 選択的ワイプを使用して保護されている場合、置き換えられたファイルは、置換ファイルのエンタープライズ ID によって保護されます。
バックアップ ファイル、置き換えられたファイル、および置換ファイルはすべて同じボリューム上に存在する必要があります。
ファイルを削除または名前変更するには、そのファイルに対する削除権限を持っているか、親ディレクトリの子権限を削除する必要があります。 削除と削除を除くすべてのアクセス権を持つディレクトリを設定し、新しいファイルの DACL が継承されている場合は、ファイルを削除しなくても作成できます。 ただし、ファイルを作成すると、ファイルの作成時に返されたハンドルに対して要求したすべてのアクセス権が取得されます。 ファイルの作成時に削除アクセス許可を要求した場合は、そのハンドルを使用してファイルを削除または名前変更できますが、他のハンドルでは削除できません。
手記
winbase.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして ReplaceFile を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
| 要件 | 価値 |
|---|---|
| サポートされる最小クライアント | Windows XP [デスクトップ アプリ |UWP アプリ] |
| サポートされる最小サーバー | Windows Server 2003 [デスクトップ アプリ |UWP アプリ] |
| ターゲット プラットフォーム の |
ウィンドウズ |
| ヘッダー | winbase.h (Windows.h を含む) |
| ライブラリ | Kernel32.lib |
| DLL | Kernel32.dll |
関連項目
MoveFile の
MoveFileEx の
MoveFileWithProgress の