以另一個檔案取代一個檔案,以及建立源文件備份複本的選項。 此函式的行為與 ReplaceFile 相同,不同之處在於此函式會遵循通用 Windows 平臺應用程式安全性模型。
語法
WINSTORAGEAPI BOOL ReplaceFileFromAppW(
LPCWSTR lpReplacedFileName,
LPCWSTR lpReplacementFileName,
LPCWSTR lpBackupFileName,
DWORD dwReplaceFlags,
LPVOID lpExclude,
LPVOID lpReserved
) noexcept;
參數
lpReplacedFileName
如需選擇退出 MAX_PATH 限制而不加上前置 “\\?\” 的資訊,請參閱 命名檔案、路徑和命名空間 的「路徑長度限制上限」一節以取得詳細資訊。
此檔案會以 GENERIC_READ、 DELETE 及 SYNCHRONIZE 存取權開啟。 共享模式 FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE。
呼叫端必須具有要取代之檔案的寫入許可權。 如需詳細資訊,請參閱 檔案安全性和存取權限。
lpReplacementFileName
將取代 lpReplacedFileName 檔案的檔案名稱。
如需選擇退出 MAX_PATH 限制而不加上前置 “\\?\” 的資訊,請參閱 命名檔案、路徑和命名空間 的「路徑長度限制上限」一節以取得詳細資訊。
函數會嘗試以 SYNCHRONIZE、GENERIC_READ、GENERIC_WRITE、DELETE 及 WRITE_DAC 存取權開啟此檔案,以便保留所有屬性及 ACL。 如果失敗,函式會嘗試以 SYNCHRONIZE、GENERIC_READ、DELETE 及 WRITE_DAC 存取權開啟檔案。 未指定共用模式。
lpBackupFileName
將作為 lpReplacedFileName 檔案備份複本的檔案名稱。 如果此參數為 Null,則不會建立任何備份檔案。 如需備份檔案的實作詳細資料,請參閱備註一節。
如需選擇退出 MAX_PATH 限制而不加上前置 “\\?\” 的資訊,請參閱 命名檔案、路徑和命名空間 的「路徑長度限制上限」一節以取得詳細資訊。
dwReplaceFlags
替換選項。 此參數可以是下列其中一或多個值。
| 價值觀 | Meaning |
|---|---|
| REPLACEFILE_WRITE_THROUGH 0x00000001 | 不支援此值。 |
| REPLACEFILE_IGNORE_MERGE_ERRORS 0x00000002 | 忽略將資訊 (例如屬性和 ACL) 從取代檔案合併至取代檔案時發生的錯誤。 因此,如果您指定此旗標且沒有 WRITE_DAC 存取權,則函式會成功,但不會保留 ACL。 |
| REPLACEFILE_IGNORE_ACL_ERRORS 0x00000004 | 忽略將 ACL 資訊從取代檔案合併至取代檔案時發生的錯誤。 因此,如果您指定此旗標且沒有 WRITE_DAC 存取權,則函式會成功,但不會保留 ACL。 若要編譯使用此值的應用程式,請將 _WIN32_WINNT 巨集定義為0x0600或更新版本。 |
lpExclude
保留供未來使用。
lpReserved
保留供未來使用。
返回值
如果函式成功,則傳回值為非零值。
如果函式失敗,傳回值為零。 若要取得擴充錯誤資訊,請呼叫 GetLastError。 以下是此功能可能的錯誤碼。
| 傳回碼/值 | Description |
|---|---|
| ERROR_UNABLE_TO_MOVE_REPLACEMENT 1176 (0x498) | 無法重新命名取代檔案。 如果指定 lpBackupFileName ,則取代和取代的檔案會保留其原始檔案名稱。 否則,取代的檔案將不再存在,且取代的檔案會以其原始名稱存在。 |
| ERROR_UNABLE_TO_MOVE_REPLACEMENT_2 1177 (0x499) | 無法移動取代檔案。 替換檔案仍以其原始名稱存在;不過,它已從要取代的檔案繼承檔案串流和屬性。 要取代的檔案仍以不同的名稱存在。 如果指定 lpBackupFileName ,它會是取代檔案的名稱。 |
| ERROR_UNABLE_TO_REMOVE_REPLACED 1175 (0x497) | 無法刪除取代的檔案。 取代和取代的檔案會保留其原始檔案名稱。 |
如果傳回任何其他錯誤,例如 ERROR_INVALID_PARAMETER,取代和取代的檔案將保留其原始檔案名稱。 在此實務範例中,備份檔案不存在,且不保證取代檔案會繼承取代檔案的所有屬性和串流。
需求
| Requirement | 價值觀 |
|---|---|
| 最低支援的用戶端 | Windows 10 版本 1803 |
| Header | fileapifromapp.h |
| Library | OneCore.Lib |