SetThreadPriorityBoost

Overview

Group

Quick Info

Windows NT
Yes
Win95
No
Win32s
No
Import Library
kernel32.lib
Header File
winbase.h
Unicode
No
Platform Notes
None

[New - Windows NT]

The SetThreadPriorityBoost function disables the ability of Windows NT to temporarily boost the priority of a thread.

BOOL SetThreadPriorityBoost(

HANDLE hThread,	// handle to thread
BOOL DisablePriorityBoost	// priority boost control state
);

Parameters
hThread

Handle to the thread whose priority is to be boosted. This thread must have the THREAD_SET_INFORMATION access right associated with it. For more information, see Thread Objects.

DisablePriorityBoost

A Boolean variable that is used to set the priority boost control state. A value of TRUE indicates that dynamic boosting is to be disabled. A value of FALSE restores normal behavior.

Return Values
If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks
When a thread is running in one of the dynamic priority classes, Windows NT temporarily boosts the thread's priority when it is taken out of a wait state. If SetThreadPriorityBoost is called with the DisablePriorityBoost parameter set to TRUE, the thread's priority is not boosted. To restore normal behavior, call SetThreadPriorityBoost with DisablePriorityBoost set to FALSE.