WdCancellationHandle

An opaque handle used to cancel an in-progress copy operation.

Syntax

typedef struct WdCancellationHandleImpl* WdCancellationHandle;

Remarks

WdCancellationHandle is a typedef pointer to an opaque internal structure. The caller is responsible for managing the handle lifecycle:

1. Create a handle by calling WdCreateCancellationHandle.
2. Pass the handle to WdRemoteCopy via the cancellationHandle parameter.
3. To cancel the in-progress copy, call WdCancelRemoteCopy with the handle from a separate thread.
4. After WdRemoteCopy returns, close the handle by calling WdCloseCancellationHandle.

A handle can be duplicated using WdDuplicateCancellationHandle. Each copy of the handle must be closed independently with WdCloseCancellationHandle.

Requirements

Requirement	Value
Header	WdRemoteIteration.h
Library	wdremoteapi.lib
Supported OS	Windows 11 and later
Supported architectures	x64, ARM64

See also

• WdCreateCancellationHandle
• WdCloseCancellationHandle
• WdDuplicateCancellationHandle
• WdRemoteCopy
• WdCancelRemoteCopy
• Xbox PC Remote Iteration API