MFPutWorkItem function (mfapi.h)

Puts an asynchronous operation on a work queue.

Syntax

HRESULT MFPutWorkItem(
  [in] DWORD            dwQueue,
  [in] IMFAsyncCallback *pCallback,
  [in] IUnknown         *pState
);

Parameters

[in] dwQueue

The identifier for the work queue. This value can specify one of the standard Media Foundation work queues, or a work queue created by the application. For list of standard Media Foundation work queues, see Work Queue Identifiers. To create a new work queue, call MFAllocateWorkQueue or MFAllocateWorkQueueEx.

[in] pCallback

A pointer to the IMFAsyncCallback interface. The caller must implement this interface.

[in] pState

A pointer to the IUnknown interface of a state object, defined by the caller. This parameter can be NULL. You can use this object to hold state information. The object is returned to the caller when the callback is invoked.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
S_OK
Success.
MF_E_INVALID_WORKQUEUE
Invalid work queue. For more information, see IMFAsyncCallback::GetParameters.
MF_E_SHUTDOWN
The MFStartup function was not called, or MFShutdown was called.

Remarks

This function creates an asynchronous result object and puts the result object on the work queue. The work queue calls the IMFAsyncCallback::Invoke method specified by pCallback.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header mfapi.h
Library Mfplat.lib
DLL Mfplat.dll

See also

MFPutWorkItemEx

Media Foundation Functions

Work Queues