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.
Creates a cancellation handle that can be used to cancel a copy operation started by WdRemoteCopy.
Syntax
HRESULT WdCreateCancellationHandle(
_Out_ WdCancellationHandle* cancellationHandle
);
Parameters
_Out_ cancellationHandle
Type: WdCancellationHandle*
Receives the newly created cancellation handle. The caller is responsible for freeing this handle by calling WdCloseCancellationHandle when it is no longer needed.
Return value
Type: HRESULT
Returns S_OK if successful; otherwise, returns an error code.
Remarks
Call WdCreateCancellationHandle before starting a copy operation to obtain a handle that enables cancellation. Pass the handle to WdRemoteCopy via the cancellationHandle parameter, and then pass it to WdCancelRemoteCopy from a separate thread to cancel the operation.
After WdRemoteCopy returns, close the handle by calling WdCloseCancellationHandle. The handle can be reused across multiple WdRemoteCopy calls, but each handle must eventually be closed.
Requirements
| Requirement | Value |
|---|---|
| Header | WdRemoteIteration.h |
| Library | wdremoteapi.lib |
| Supported OS | Windows 11 and later |
| Supported architectures | x64, ARM64 |