Syntax
Parameters
_In_ cancellationHandleType: WdCancellationHandle The cancellation handle created by WdCreateCancellationHandle and passed to WdDeleteRemoteFiles. Signaling this handle requests cancellation of the client wait.
Return value
Type: HRESULT ReturnsS_OK if successful; otherwise, returns an error code.
Remarks
CallWdCancelRemoteDelete from a separate thread to signal cancellation of a blocking WdDeleteRemoteFiles call. WdCancelRemoteDelete is a non-blocking function. If WdDeleteRemoteFiles observes the signal, it stops waiting and returns S_OK without confirming endpoint completion.
Because observed cancellation and normal completion both return S_OK, a caller that may cancel can’t determine the outcome from the return value alone. Track cancellation state in your own code if you need to distinguish the two, for example, to suppress an error message or skip a retry after a user-initiated cancel.
Cancellation does not stop deletion already started on the endpoint, which continues independently. It does not restore items that were already deleted.