IMFWorkQueueServices::BeginRegisterPlatformWorkQueueWithMMCSS method (mfidl.h)

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

Syntax

HRESULT BeginRegisterPlatformWorkQueueWithMMCSS(
  [in] DWORD            dwPlatformWorkQueue,
  [in] LPCWSTR          wszClass,
  [in] DWORD            dwTaskId,
  [in] IMFAsyncCallback *pCallback,
  [in] IUnknown         *pState
);

Parameters

[in] dwPlatformWorkQueue

The platform work queue to register with MMCSS. See Work Queue Identifiers. To register all of the standard work queues to the same MMCSS task, set this parameter to MFASYNC_CALLBACK_QUEUE_ALL.

[in] wszClass

The name of the MMCSS task to be performed.

[in] dwTaskId

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

[in] pCallback

A pointer to the IMFAsyncCallback interface of a callback object. 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

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

Remarks

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

To unregister the work queue from the MMCSS class, call IMFWorkQueueServices::BeginUnregisterPlatformWorkQueueWithMMCSS.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header mfidl.h
Library Mfuuid.lib

See also

IMFWorkQueueServices