Skip to content

Latest commit

 

History

History
110 lines (78 loc) · 3.82 KB

nf-processthreadsapi-setthreadpriorityboost.md

File metadata and controls

110 lines (78 loc) · 3.82 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:processthreadsapi.SetThreadPriorityBoost
SetThreadPriorityBoost function (processthreadsapi.h)
Disables or enables the ability of the system to temporarily boost the priority of a thread.
SetThreadPriorityBoost
SetThreadPriorityBoost function
_win32_setthreadpriorityboost
base.setthreadpriorityboost
processthreadsapi/SetThreadPriorityBoost
winbase/SetThreadPriorityBoost
base\setthreadpriorityboost.htm
processthreadsapi
5cc16bfe-6792-40e8-91ef-6f54a38e6e33
12/05/2018
SetThreadPriorityBoost, SetThreadPriorityBoost function, _win32_setthreadpriorityboost, base.setthreadpriorityboost, processthreadsapi/SetThreadPriorityBoost, winbase/SetThreadPriorityBoost
processthreadsapi.h
Windows.h on Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2
Windows
Windows XP [desktop apps \| UWP apps]
Windows Server 2003 [desktop apps \| UWP apps]
Kernel32.lib
Kernel32.dll
Windows
19H1
SetThreadPriorityBoost
processthreadsapi/SetThreadPriorityBoost
c++
APIRef
kbSyntax
DllExport
Kernel32.dll
API-MS-Win-Core-ProcessThreads-l1-1-0.dll
KernelBase.dll
MinKernelBase.dll
API-MS-Win-Core-ProcessThreads-l1-1-1.dll
API-MS-Win-Core-ProcessThreads-l1-1-2.dll
api-ms-win-downlevel-kernel32-l1-1-0.dll
API-MS-Win-Core-ProcessThreads-L1-1-3.dll
SetThreadPriorityBoost

SetThreadPriorityBoost function

-description

Disables or enables the ability of the system to temporarily boost the priority of a thread.

-parameters

-param hThread [in]

A handle to the thread whose priority is to be boosted. The handle must have the THREAD_SET_INFORMATION or THREAD_SET_LIMITED_INFORMATION access right. For more information, see Thread Security and Access Rights.

Windows Server 2003 and Windows XP:  The handle must have the THREAD_SET_INFORMATION access right.

-param bDisablePriorityBoost [in]

If this parameter is TRUE, dynamic boosting is disabled. If the parameter is FALSE, dynamic boosting is enabled.

-returns

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, the system 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.

-see-also

GetThreadPriorityBoost

OpenThread

Priority Boosts

Process and Thread Functions

Scheduling Priorities

Threads