RemoveDirectory2A 函式 (fileapi.h)

刪除現有的空白目錄。 如果 lpPathName 的任何部分透過重新分析點或符號連結重新導向,此函式將會失敗。

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

語法

BOOL RemoveDirectory2A(
  LPCSTR          lpPathName,
  DIRECTORY_FLAGS DirectoryFlags
);

參數

lpPathName

要移除之目錄的路徑。 此路徑必須指定空的目錄,而且呼叫進程必須具有目錄的刪除存取權。

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

小提示

您可以加入加入以移除 MAX_PATH 限制,而不需加上 “\\?\”。 如需詳細資訊,請參閱 命名檔案、路徑和命名空間 的一節。

DirectoryFlags

指定如何刪除目錄的旗標。 此參數可以是下列值的組合:

價值 意義
DIRECTORY_FLAGS_DISALLOW_PATH_REDIRECTS
0x00000001
防止重新分析點或符號連結重新導向 lpPathName 。

返回值

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

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

備註

RemoveDirectory2 函式會在關閉時標示要刪除的目錄。 因此,在關閉目錄的最後一個句柄之前,不會移除目錄。

若要以遞歸方式刪除目錄中的檔案,請使用 SHFileOperation 函式。

RemoveDirectory2 可用來移除目錄連接點。 由於目標目錄及其內容仍可透過標準路徑存取,因此目標目錄本身不會受到移除目標連接點的影響。 基於這個理由,當 lpPathName 參考目錄連接點時, RemoveDirectory2 會移除指定的連結,而不論目標目錄是否空白。 如需連接點的詳細資訊,請參閱 硬式連結和連接點。

使用 POSIX 刪除會導致在句柄保持開啟時刪除目錄。 後續呼叫 CreateDirectory 或 CreateDirectory2 以開啟目錄時失敗,ERROR_FILE_NOT_FOUND。

下列技術支援此函式:

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

備註

標頭會將 fileapi.hRemoveDirectory2 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型 的慣例。

需求

要求 價值
最低支援的用戶端 Windows 11 24H2 [傳統型應用程式 |UWP 應用程式]
支援的最低伺服器 Windows Server 2025 [傳統型應用程式 |UWP 應用程式]
標題 fileapi.h (包括 Windows.h)
程式庫 Kernel32.lib
DLL Kernel32.dll

另請參閱

CreateDirectory2

建立和刪除目錄

Directory Management Functions

RemoveDirectoryTransacted