Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

MFCancelWorkItem function

Attempts to cancel an asynchronous operation that was scheduled with MFScheduleWorkItem or MFScheduleWorkItemEx.

Syntax


HRESULT MFCancelWorkItem(
  _In_  MFWORKITEM_KEY Key
);

Parameters

Key [in]

The key that was received in the pKey parameter of the MFScheduleWorkItem, MFScheduleWorkItemEx, or MFPutWaitingWorkItem functions.

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 MFCancelWorkItem is called.

This function is available on the following platforms if the Windows Media Format 11 SDK redistributable components are installed:

  • Windows XP with Service Pack 2 (SP2) and later.
  • Windows XP Media Center Edition 2005 with KB900325 (Windows XP Media Center Edition 2005) and KB925766 (October 2006 Update Rollup for Windows XP Media Center Edition) installed.

Windows Phone 8.1: This API is supported.

Requirements

Minimum supported client

Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]

Header

Mfapi.h

Library

Mfplat.lib

DLL

Mfplat.dll

See also

Media Foundation Functions
Work Queues

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.