MFGetWorkQueueMMCSSClass function (mfapi.h)

Article
02/22/2024

Retrieves the Multimedia Class Scheduler Service (MMCSS) class currently associated with this work queue.

Syntax

HRESULT MFGetWorkQueueMMCSSClass(
  [in]      DWORD  dwWorkQueueId,
  [out]     LPWSTR pwszClass,
  [in, out] DWORD  *pcchClass
);

Parameters

[in] dwWorkQueueId

Identifier for the work queue. The identifier is retrieved by the MFAllocateWorkQueue function.

[out] pwszClass

Pointer to a buffer that receives the name of the MMCSS class. This parameter can be NULL.

[in, out] pcchClass

On input, specifies the size of the pwszClass buffer, in characters. On output, receives the required size of the buffer, in characters. The size includes the terminating null character.

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.
MF_E_BUFFERTOOSMALL	The pwszClass buffer is too small to receive the task name.

Remarks

If the work queue is not associated with an MMCSS task, the function retrieves an empty string.

To associate a work queue with an MMCSS task, call MFBeginRegisterWorkQueueWithMMCSS.

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