> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# WdDeleteOptions

> WdDeleteOptions 的参考，该结构设置 WdDeleteRemoteFiles 操作期间的公共根别名以及是否删除根文件夹。

# WdDeleteOptions

指定远程设备上删除操作的选项。

**引入版本：** [RIT 0.0.13-preview](/zh-CN/reference/remoting/release-versions#release-versions)。

## 语法

```cpp theme={null}
struct WdDeleteOptions
{
    const char* commonRootAlias;
    bool deleteRootFolder;
};
```

### 成员

`commonRootAlias`\
类型：**const char\***

远程设备上公共根位置的可选别名（UTF-8）。设置为 `nullptr` 可使用默认公共根位置。

`deleteRootFolder`\
类型：**bool**

为 `true` 时，在删除 `remoteFolderPath` 文件夹的内容后会尝试删除该文件夹本身，但仅当该文件夹为空时才会删除。如果经过筛选的删除留下了某些项，则会保留该文件夹。为 `false`（默认值）时，仅删除 `remoteFolderPath` 的内容，文件夹本身保留不变。当 `remoteFolderPath` 解析为单个文件时，将忽略此字段。

此字段仅控制是否删除 `remoteFolderPath` 本身。无论其值如何，该操作都会尝试删除通过目录筛选器的空子目录，包括原本就为空的目录。

## 备注

通过 `deleteOptions` 参数将此结构传递给 [WdDeleteRemoteFiles](/zh-CN/reference/remoting/functions/wddeleteremotefiles)。如果为 `deleteOptions` 传递 `nullptr`，则当 `remoteFolderPath` 为相对路径时使用默认公共根位置，并且仅删除文件夹的内容。

删除是尽力而为的。[WdDeleteRemoteFiles](/zh-CN/reference/remoting/functions/wddeleteremotefiles) 成功返回并不保证每个选定的项或根文件夹都已被删除。

如果 `remoteFolderPath` 是绝对路径，则忽略 `commonRootAlias`。如果 `remoteFolderPath` 是相对路径，则会相对于该别名标识的公共根进行解析；如果未指定别名，则相对于默认公共根位置进行解析。

## 要求

| 要求 | 值 |
| - | - |
| **头文件** | WdRemoteIteration.h |
| **库** | wdremoteapi.lib |
| **支持的操作系统** | Windows 11 及更高版本 |
| **支持的体系结构** | x64、ARM64 |

## 另请参阅

* [WdDeleteRemoteFiles](/zh-CN/reference/remoting/functions/wddeleteremotefiles)
* [WdDeleteSearchOptions](/zh-CN/reference/remoting/structs/wddeletesearchoptions)
* [XBOX PC 远程迭代 API](/zh-CN/reference/remoting/remoteiteration_members)


## Related topics

- [WdDeleteSearchOptions](/zh-CN/reference/remoting/structs/wddeletesearchoptions.md)
- [WdDeleteRemoteFiles](/zh-CN/reference/remoting/functions/wddeleteremotefiles.md)
- [WdCopyOptions](/zh-CN/reference/remoting/structs/wdcopyoptions.md)
- [WdLaunchOptions](/zh-CN/reference/remoting/structs/wdlaunchoptions.md)
- [WdDeleteProgressCallback](/zh-CN/reference/remoting/callbacks/wddeleteprogresscallback.md)