WdDeleteOptions
指定在遠端裝置上執行刪除作業的選項。 推出版本: RIT 0.0.13-preview。語法
成員
commonRootAlias類型:const char* 遠端裝置上通用根位置的選用別名 (UTF-8)。設為
nullptr 以使用預設的通用根位置。
deleteRootFolder類型:bool 設為
true 時,會在 remoteFolderPath 資料夾的內容刪除後嘗試移除該資料夾本身,但僅限於該資料夾已清空的情況。若經過篩選的刪除留下部分項目,則會保留該資料夾。設為 false (預設值) 時,只會刪除 remoteFolderPath 的內容,資料夾本身則會保留。當 remoteFolderPath 解析為單一檔案時,會忽略此欄位。
此欄位只控制 remoteFolderPath 本身的移除。無論其值為何,作業都會嘗試移除通過目錄篩選條件的空白子目錄,包括原本就是空白的目錄。
備註
透過deleteOptions 參數將此結構傳遞給 WdDeleteRemoteFiles。如果為 deleteOptions 傳遞 nullptr,當 remoteFolderPath 為相對路徑時會使用預設的通用根位置,而且只會刪除資料夾的內容。
刪除作業會盡力執行。WdDeleteRemoteFiles 成功傳回並不保證每個選取的項目或根資料夾都已移除。
如果 remoteFolderPath 是絕對路徑,則會忽略 commonRootAlias。如果 remoteFolderPath 是相對路徑,則會根據別名所識別的通用根進行解析;若未指定別名,則根據預設的通用根位置進行解析。
