MFBeginRegisterWorkQueueWithMMCSS function (mfapi.h)

Associates a work queue with a Multimedia Class Scheduler Service (MMCSS) task.

Syntax

HRESULT MFBeginRegisterWorkQueueWithMMCSS(
  [in] DWORD            dwWorkQueueId,
  [in] LPCWSTR          wszClass,
  [in] DWORD            dwTaskId,
  [in] IMFAsyncCallback *pDoneCallback,
  [in] IUnknown         *pDoneState
);

Parameters

[in] dwWorkQueueId

The identifier of the work queue. For private work queues, the identifier is returned by the MFAllocateWorkQueue function. For platform work queues, see Work Queue Identifiers.

[in] wszClass

The name of the MMCSS task.For more information, see Multimedia Class Scheduler Service.

[in] dwTaskId

The unique task identifier. To obtain a new task identifier, set this value to zero.

[in] pDoneCallback

A pointer to the IMFAsyncCallback interface of a callback object. The caller must implement this interface.

[in] pDoneState

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

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
The function succeeded.

Remarks

This function is asynchronous. When the operation completes, the callback object's IMFAsyncCallback::Invoke method is called. At that point, the application should call MFEndRegisterWorkQueueWithMMCSS to complete the asynchronous request.

To unregister the work queue from the MMCSS task, call MFBeginUnregisterWorkQueueWithMMCSS.

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

Media Foundation Functions

Work Queues