Windows Dev Center

Collapse the table of content
Expand the table of content
Expand Minimize

GetThreadPriorityBoost function

Retrieves the priority boost control state of the specified thread.

Syntax


BOOL WINAPI GetThreadPriorityBoost(
  _In_  HANDLE hThread,
  _Out_ PBOOL  pDisablePriorityBoost
);

Parameters

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 and Windows XP:  The handle must have the THREAD_QUERY_INFORMATION access right.

pDisablePriorityBoost [out]

A pointer to a variable that receives the priority boost control state. A value of TRUE indicates that dynamic boosting is disabled. A value of FALSE indicates normal behavior.

Return value

If the function succeeds, the return value is nonzero. In that case, the variable pointed to by the pDisablePriorityBoost parameter receives the priority boost control state.

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

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

WinBase.h on Windows XP, Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008, and Windows Server 2008 R2 (include Windows.h);
Processthreadsapi.h on Windows 8 and Windows Server 2012

Library

Kernel32.lib

DLL

Kernel32.dll

See also

OpenThread
Priority Boosts
Process and Thread Functions
Scheduling Priorities
SetThreadPriorityBoost
Threads

 

 

Community Additions

ADD
Show:
© 2015 Microsoft