WdDeleteOptions
リモート デバイスでの削除操作のオプションを指定します。 導入バージョン: RIT 0.0.13-preview。構文
メンバー
commonRootAliasType: const char* リモート デバイス上の共通ルートの場所を示す省略可能なエイリアス (UTF-8)。既定の共通ルートの場所を使用するには、
nullptr に設定します。
deleteRootFolderType: bool
true の場合、remoteFolderPath の内容が削除された後、フォルダーが空になったときに限り、そのフォルダー自体の削除が試みられます。フィルター処理された削除によって項目が残った場合、フォルダーは保持されます。false (既定値) の場合、remoteFolderPath の内容のみが削除され、フォルダー自体はそのまま残ります。remoteFolderPath が単一のファイルに解決される場合、このフィールドは無視されます。
このフィールドが制御するのは、remoteFolderPath 自体の削除のみです。値にかかわらず、この操作では、ディレクトリ フィルターを通過した空のサブディレクトリ (元から空だったディレクトリを含む) の削除を試みます。
解説
この構造体をdeleteOptions パラメーターを介して WdDeleteRemoteFiles に渡します。deleteOptions に nullptr を渡した場合、remoteFolderPath が相対パスであれば既定の共通ルートの場所が使用され、フォルダーの内容のみが削除されます。
削除はベスト エフォートで行われます。WdDeleteRemoteFiles が正常に戻った場合でも、選択されたすべての項目やルート フォルダーが削除されたことは保証されません。
remoteFolderPath が絶対パスの場合、commonRootAlias は無視されます。remoteFolderPath が相対パスの場合は、エイリアスで示される共通ルートを基準として解決されます。エイリアスが指定されていない場合は、既定の共通ルートの場所を基準として解決されます。