> ## 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.

# WdCancelRemoteDelete

> WdCancelRemoteDelete 的参考，该函数为 WdDeleteRemoteFiles 调用的客户端等待发出取消信号，包含语法和备注。

# WdCancelRemoteDelete

为删除操作的客户端等待发出取消信号。

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

## 语法

```cpp theme={null}
HRESULT WdCancelRemoteDelete(  
         _In_ WdCancellationHandle cancellationHandle  
);  
```

### 参数

`_In_ cancellationHandle`\
类型：**[WdCancellationHandle](/zh-CN/reference/remoting/structs/wdcancellationhandle)**

由 [WdCreateCancellationHandle](/zh-CN/reference/remoting/functions/wdcreatecancellationhandle) 创建并传递给 [WdDeleteRemoteFiles](/zh-CN/reference/remoting/functions/wddeleteremotefiles) 的取消句柄。发出此句柄的信号将请求取消客户端等待。

### 返回值

类型：**HRESULT**

如果成功，则返回 `S_OK`；否则，返回错误代码。

## 备注

从单独的线程调用 `WdCancelRemoteDelete`，可为阻塞的 [WdDeleteRemoteFiles](/zh-CN/reference/remoting/functions/wddeleteremotefiles) 调用发出取消信号。`WdCancelRemoteDelete` 是一个非阻塞函数。如果 `WdDeleteRemoteFiles` 观察到该信号，它将停止等待并返回 `S_OK`，而不确认终结点是否已完成。

由于观察到取消和正常完成都返回 `S_OK`，因此可能执行取消的调用方无法仅凭返回值确定结果。如果需要区分这两种情况，请在自己的代码中跟踪取消状态，例如，在用户发起取消后禁止显示错误消息或跳过重试。

取消不会停止已在终结点上开始的删除操作，该操作会独立继续进行。取消也不会还原已删除的项。

## 要求

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

## 另请参阅

* [WdDeleteRemoteFiles](/zh-CN/reference/remoting/functions/wddeleteremotefiles)
* [WdCancellationHandle](/zh-CN/reference/remoting/structs/wdcancellationhandle)
* [WdCreateCancellationHandle](/zh-CN/reference/remoting/functions/wdcreatecancellationhandle)
* [WdCloseCancellationHandle](/zh-CN/reference/remoting/functions/wdclosecancellationhandle)
* [XBOX PC 远程迭代 API](/zh-CN/reference/remoting/remoteiteration_members)


## Related topics

- [WdDeleteRemoteFiles](/zh-CN/reference/remoting/functions/wddeleteremotefiles.md)
- [WdCancelRemoteCopy](/zh-CN/reference/remoting/functions/wdcancelremotecopy.md)
- [WdCancellationHandle](/zh-CN/reference/remoting/structs/wdcancellationhandle.md)
- [WdRemoteCopy](/zh-CN/reference/remoting/functions/wdremotecopy.md)
- [WdCreateCancellationHandle](/zh-CN/reference/remoting/functions/wdcreatecancellationhandle.md)