刪除現有的檔案。 如果 lpFileName 的任何部分透過重新分析點或符號連結重新導向,此函式將會失敗。
若要以交易作業的形式執行這項作業,請使用 DeleteFileTransacted 函式。
語法
BOOL DeleteFile2A(
LPCSTR lpFileName,
DWORD Flags
);
參數
lpFileName
要刪除的檔名。
根據預設,名稱限製為 MAX_PATH 個字元。 若要將此限制延伸至 32,767 寬字元,請在路徑前面加上 “\\?\”。 如需詳細資訊,請參閱 命名檔案、路徑和命名空間。
小提示
您可以加入加入以移除 MAX_PATH 限制,而不需加上 “\\?\”。 如需詳細資訊,請參閱 命名檔案、路徑和命名空間 的一節。
Flags
旗標,指定如何處理正在刪除的檔案。 此參數可以是下列其中一個值的組合:
| 價值 | 意義 |
|---|---|
FILE_FLAG_DISALLOW_PATH_REDIRECTS0x00010000 |
防止重新分析點或符號連結重新導向 lpFileName 。 |
返回值
如果函式成功,則傳回值為非零值。
如果函式失敗,傳回值為零 (0)。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。 可能的錯誤包括下列各項:
| 回傳碼 | 說明 |
|---|---|
| ERROR_PATH_REDIRECTED | lpFileName 是由重新剖析點和/或符號連結重新導向。 |
備註
如果應用程式嘗試刪除不存在的檔案, DeleteFile2 函式會失敗並 ERROR_FILE_NOT_FOUND。 如果檔案是只讀檔案,函式會失敗並 ERROR_ACCESS_DENIED。
下列清單會識別刪除、移除或關閉檔案的一些秘訣:
- 若要刪除唯讀檔案,您必須先移除唯讀屬性。
- 若要刪除或重新命名檔案,您必須擁有檔案的刪除許可權,或刪除父目錄中的子許可權。
- 若要以遞歸方式刪除目錄中的檔案,請使用 SHFileOperation 函式。
- 若要移除空的目錄,請使用 RemoveDirectory 函式。
- 若要關閉開啟的檔案,請使用 CloseHandle 函 式。
如果您設定具有刪除和刪除子系以外的所有存取權目錄,以及繼承新檔案的訪問控制清單 (ACL),則您可以建立檔案,而不需要刪除它。 不過,您可以建立檔案,然後取得您在建立檔案時傳回之句柄上要求的所有存取權。
如果您在建立檔案時要求刪除許可權,您可以使用該句柄刪除或重新命名檔案,但不能使用任何其他句柄來刪除或重新命名檔案。 如需詳細資訊,請參閱 檔案安全性和存取權限。
如果應用程式嘗試刪除其他句柄為一般 I/O 開啟的檔案或記憶體對應檔案,則 DeleteFile2 函式會失敗(FILE_SHARE_DELETE 必須在開啟其他句柄時指定)。
DeleteFile2 函式會在關閉時標記要刪除的檔案。 因此,在關閉檔案的最後一個句柄之前,不會刪除檔案。 後續呼叫 CreateFile、 CreateFile2 或 CreateFile3 以開啟檔案時失敗, ERROR_ACCESS_DENIED。
使用 POSIX 刪除會導致檔案在句柄保持開啟時刪除。 後續呼叫 CreateFile 以開啟檔案時失敗,ERROR_FILE_NOT_FOUND。
符號連結行為
如果路徑指向符號連結,則會刪除符號連結,而不是目標。 若要刪除目標,您必須呼叫 CreateFile 並指定 FILE_FLAG_DELETE_ON_CLOSE。
下列技術支援此函式:
| 科技 | 支持 |
|---|---|
| 伺服器消息塊 (SMB) 3.0 通訊協定 | 是的 |
| SMB 3.0 透明故障轉移 (TFO) | 是的 |
| 具有向外延展檔案共用的SMB 3.0(SO) | 是的 |
| 叢集共用磁碟區檔案系統 (CsvFS) | 是的 |
| 復原檔案系統 (ReFS) | 是的 |
備註
標頭會將 fileapi.hDeleteFile2 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型 的慣例。
範例
如需範例,請參閱 鎖定和解除鎖定檔案中的位元組範圍。
需求
| 要求 | 價值 |
|---|---|
| 最低支援的用戶端 | Windows 11 24H2 [傳統型應用程式 |UWP 應用程式] |
| 支援的最低伺服器 | Windows Server 2025 [傳統型應用程式 |UWP 應用程式] |
| 標題 | fileapi.h (包括 Windows.h) |
| 程式庫 | Kernel32.lib |
| DLL | Kernel32.dll |