Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Cancels an in-progress copy operation.
Syntax
HRESULT WdCancelRemoteCopy(
_In_ WdCancellationHandle cancellationHandle
);
Parameters
_In_ cancellationHandle
Type: WdCancellationHandle
The cancellation handlecreated by WdCreateCancellationHandle and passed to WdRemoteCopy. Signaling this handle causes the in-progress copy to be cancelled.
Return value
Type: HRESULT
Returns S_OK if successful; otherwise, returns an error code.
Remarks
Call WdCancelRemoteCopy from a separate thread to cancel a blocking WdRemoteCopy call. WdCancelRemoteCopy is a non-blocking function. After cancellation is signaled, WdRemoteCopy will cancel the copy and return S_OK.
Requirements
| Requirement | Value |
|---|---|
| Header | WdRemoteIteration.h |
| Library | wdremoteapi.lib |
| Supported OS | Windows 11 and later |
| Supported architectures | x64, ARM64 |