WdDuplicateCancellationHandle

Duplicates an existing WdCancellationHandle.

Syntax

HRESULT WdDuplicateCancellationHandle(  
         _In_ WdCancellationHandle cancellationHandle,  
         _Out_ WdCancellationHandle* duplicatedHandle  
);  

Parameters

_In_ cancellationHandle
Type: WdCancellationHandle The cancellation handle to duplicate. _Out_ duplicatedHandle
Type: WdCancellationHandle* Receives the duplicated cancellation handle. The caller is responsible for closing this handle independently by calling WdCloseCancellationHandle.

Return value

Type: HRESULT Returns S_OK if successful; otherwise, returns an error code.

Remarks

Use WdDuplicateCancellationHandle when multiple components need to reference the same cancellation handle. Both the original and duplicated handles refer to the same cancellation state — signaling cancellation via WdCancelRemoteCopy on either handle cancels the associated WdRemoteCopy operation. Each 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

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

WdDuplicateCancellationHandle

WdDuplicateCancellationHandle

Syntax

Parameters

Return value

Remarks

Requirements

See also

​WdDuplicateCancellationHandle

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

WdDuplicateCancellationHandle

Syntax

Parameters

Return value

Remarks

Requirements

See also