Skip to content

Latest commit

 

History

History
216 lines (168 loc) · 6.47 KB

nf-processthreadsapi-getthreadpriority.md

File metadata and controls

216 lines (168 loc) · 6.47 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.GetThreadPriority
GetThreadPriority function (processthreadsapi.h)
Retrieves the priority value for the specified thread. This value, together with the priority class of the thread's process, determines the thread's base-priority level.
GetThreadPriority
GetThreadPriority function
_win32_getthreadpriority
base.getthreadpriority
processthreadsapi/GetThreadPriority
winbase/GetThreadPriority
base\getthreadpriority.htm
processthreadsapi
9e5ce4e8-bdd1-48c3-aa1d-b24b2b7bfb00
12/05/2018
GetThreadPriority, GetThreadPriority function, _win32_getthreadpriority, base.getthreadpriority, processthreadsapi/GetThreadPriority, winbase/GetThreadPriority
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; WindowsPhoneCore.lib on Windows Phone 8.1
Kernel32.dll; KernelBase.dll on Windows Phone 8.1
Windows
19H1
GetThreadPriority
processthreadsapi/GetThreadPriority
c++
APIRef
kbSyntax
DllExport
Kernel32.dll
KernelBase.dll
API-MS-Win-Core-ProcessThreads-l1-1-0.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
GetThreadPriority

GetThreadPriority function

-description

Retrieves the priority value for the specified thread. This value, together with the priority class of the thread's process, determines the thread's base-priority level.

-parameters

-param hThread [in]

A handle to the thread.

The handle must have the THREAD_QUERY_INFORMATION or THREAD_QUERY_LIMITED_INFORMATION access right. For more information, see Thread Security and Access Rights.

Windows Server 2003:  The handle must have the THREAD_QUERY_INFORMATION access right.

-returns

If the function succeeds, the return value is the thread's priority level.

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

Windows Phone 8.1:  This function will always return THREAD_PRIORITY_NORMAL.

The thread's priority level is one of the following values.

Return code/value Description
THREAD_PRIORITY_ABOVE_NORMAL
1
Priority 1 point above the priority class.
THREAD_PRIORITY_BELOW_NORMAL
-1
Priority 1 point below the priority class.
THREAD_PRIORITY_HIGHEST
2
Priority 2 points above the priority class.
THREAD_PRIORITY_IDLE
-15
Base priority of 1 for IDLE_PRIORITY_CLASS, BELOW_NORMAL_PRIORITY_CLASS, NORMAL_PRIORITY_CLASS, ABOVE_NORMAL_PRIORITY_CLASS, or HIGH_PRIORITY_CLASS processes, and a base priority of 16 for REALTIME_PRIORITY_CLASS processes.
THREAD_PRIORITY_LOWEST
-2
Priority 2 points below the priority class.
THREAD_PRIORITY_NORMAL
0
Normal priority for the priority class.
THREAD_PRIORITY_TIME_CRITICAL
15
Base-priority level of 15 for IDLE_PRIORITY_CLASS, BELOW_NORMAL_PRIORITY_CLASS, NORMAL_PRIORITY_CLASS, ABOVE_NORMAL_PRIORITY_CLASS, or HIGH_PRIORITY_CLASS processes, and a base-priority level of 31 for REALTIME_PRIORITY_CLASS processes.
 

If the thread has the REALTIME_PRIORITY_CLASS base class, this function can also return one of the following values: -7, -6, -5, -4, -3, 3, 4, 5, or 6. For more information, see Scheduling Priorities.

-remarks

Every thread has a base-priority level determined by the thread's priority value and the priority class of its process. The operating system uses the base-priority level of all executable threads to determine which thread gets the next slice of CPU time. Threads are scheduled in a round-robin fashion at each priority level, and only when there are no executable threads at a higher level will scheduling of threads at a lower level take place.

For a table that shows the base-priority levels for each combination of priority class and thread priority value, refer to the SetPriorityClass function.

Windows 8.1 and Windows Server 2012 R2: This function is supported for Windows Store apps.

Windows Phone 8.1:Windows Phone Store apps may call this function but it has no effect.

-see-also

GetPriorityClass

OpenThread

Process and Thread Functions

Scheduling Priorities

SetPriorityClass

SetThreadPriority

Threads