DeleteFile 函式(winbase.h)

刪除現有的檔案。

若要以交易作業的形式執行這項作業,請使用 DeleteFileTransacted 函式。

語法

BOOL DeleteFile(
  [in] LPCTSTR lpFileName
);

Parameters

[in] lpFileName

要刪除的檔案的名稱。

根據預設,名稱限製為MAX_PATH個字元。 若要將此限制延伸至 32,767 寬字元,請在路徑前面加上 “\\?\”。 欲了解更多資訊,請參閱 命名檔案、路徑與命名空間。

Tip

從 Windows 10 版本 1607 開始,您可以選擇移除MAX_PATH限制,而不需預先加上 “\\?\”。 如需詳細資訊,請參閱 命名檔案、路徑和命名空間 的一節。

返回值

如果函式成功,則傳回非零的值。

如果函式失敗,傳回值為零 (0) 。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。

備註

如果應用程式嘗試刪除不存在的檔案, DeleteFile 函式會隨 ERROR_FILE_NOT_FOUND 失敗。 如果檔案是只讀檔案,函式會失敗並 ERROR_ACCESS_DENIED。

下列清單會識別刪除、移除或關閉檔案的一些秘訣:

  • 若要刪除唯讀檔案,您必須先移除唯讀屬性。
  • 若要刪除或重新命名檔案,您必須擁有檔案的刪除許可權,或刪除父目錄中的子許可權。
  • 若要以遞歸方式刪除目錄中的檔案,請使用 SHFileOperation 函式。
  • 若要移除空的目錄,請使用 RemoveDirectory 函式。
  • 若要關閉開啟的檔案,請使用 CloseHandle 函 式。
如果您設定具有刪除和刪除子系以外的所有存取權目錄,以及繼承新檔案的訪問控制清單 (ACL),則您可以建立檔案,而不需要刪除它。 不過,您可以建立檔案,然後取得您在建立檔案時傳回之句柄上要求的所有存取權。

如果您在建立檔案時要求刪除許可權,您可以使用該句柄刪除或重新命名檔案,但不能使用任何其他句柄來刪除或重新命名檔案。 如需詳細資訊,請參閱 檔案安全性和存取權限。

若應用程式嘗試刪除有其他未開啟的帳號,且未FILE_SHARE_DELETE開啟,或是記憶體映射的檔案,則 DeleteFile 函式會失敗。

DeleteFile 功能會在關閉時標記檔案要刪除。 因此,在關閉檔案的最後一個句柄之前,不會刪除檔案。 後續呼叫 CreateFile 以開啟檔案時, ERROR_ACCESS_DENIED 失敗。

符號連結行為—

如果路徑指向符號連結,則會刪除符號連結,而不是目標。 若要刪除目標,您必須呼叫 CreateFile 並指定 FILE_FLAG_DELETE_ON_CLOSE。

在 Windows 8 和 Windows Server 2012 中,下列技術支援此功能。

科技 支援
伺服器消息塊 (SMB) 3.0 通訊協定 是的
SMB 3.0 透明故障轉移 (TFO) 是的
具有向外延展檔案共用的SMB 3.0(SO) 是的
叢集共用磁碟區檔案系統 (CsvFS) 是的
復原檔案系統 (ReFS) 是的
 

範例

如需範例,請參閱 鎖定和解除鎖定檔案中的位元組範圍。

要求

需求 價值
最低支援的用戶端 Windows XP [桌面應用程式 |UWP 應用程式]
支援的最低伺服器 Windows Server 2003 [桌面應用程式 |UWP 應用程式]
目標平臺 Windows 作業系統
標頭 winbase.h (包括 Windows.h)
範本庫 Kernel32.lib
DLL Kernel32.dll

另請參閱

CloseHandle

CreateFile

刪除檔案交易

檔案管理功能

符號連結