RtwqCancelWorkItem function (rtworkq.h)

Attempts to cancel an asynchronous operation that was scheduled with RtwqScheduleWorkItem.

Syntax

HRESULT RtwqCancelWorkItem(
  [in] RTWQWORKITEM_KEY Key
);

Parameters

[in] Key

The key that was received in the key parameter of the RtwqScheduleWorkItem.

Return value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Because work items are asynchronous, the work-item callback might still be invoked after RtwqCancelWorkItem is called.

Requirements

Requirement Value
Minimum supported client Windows 8.1 [desktop apps only]
Minimum supported server Windows Server 2012 R2 [desktop apps only]
Target Platform Windows
Header rtworkq.h
Library Rtworkq.lib
DLL RTWorkQ.dll