MFBeginUnregisterWorkQueueWithMMCSS function (mfapi.h)

Article
02/22/2024

Unregisters a work queue from a Multimedia Class Scheduler Service (MMCSS) task.

Syntax

HRESULT MFBeginUnregisterWorkQueueWithMMCSS(
  [in] DWORD            dwWorkQueueId,
  [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] pDoneCallback

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

[in] pDoneState

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 unregisters a work queue that was associated with an MMCSS class through the MFBeginRegisterWorkQueueWithMMCSS function.

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

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