AvSetMmThreadCharacteristicsA function

Associates the calling thread with the specified task.

Syntax

AVRTAPI HANDLE AvSetMmThreadCharacteristicsA(
  LPCSTR  TaskName,
  LPDWORD TaskIndex
);

Parameters

TaskName

The name of the task to be performed. This name must match the name of one of the subkeys of the following key HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Multimedia\SystemProfile\Tasks.

TaskIndex

The unique task identifier. The first time this function is called, this value must be 0 on input. The index value is returned on output and can be used as input in subsequent calls.

Return Value

If the function succeeds, it returns a handle to the task.

If the function fails, it returns 0. To retrieve extended error information, call GetLastError.

The following are possible error codes.

Return code Description
ERROR_INVALID_TASK_INDEX
Either TaskIndex is not 0 on the first call or is not recognized value (on subsequent calls).
ERROR_INVALID_TASK_NAME
The specified task does not match any of the tasks stored in the registry.
ERROR_PRIVILEGE_NOT_HELD
The caller does not have sufficient privilege.

Remarks

When the task is completed, call the AvRevertMmThreadCharacteristics function.

Requirements

   
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header avrt.h
Library Avrt.lib
DLL Avrt.dll

See Also

Multimedia Class Scheduler Service