Skip to content

Latest commit

 

History

History
99 lines (72 loc) · 3.62 KB

nf-realtimeapiset-queryidleprocessorcycletime.md

File metadata and controls

99 lines (72 loc) · 3.62 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:realtimeapiset.QueryIdleProcessorCycleTime
QueryIdleProcessorCycleTime function (realtimeapiset.h)
Retrieves the cycle time for the idle thread of each processor in the system.
QueryIdleProcessorCycleTime
QueryIdleProcessorCycleTime function
base.queryidleprocessorcycletime
realtimeapiset/QueryIdleProcessorCycleTime
winbase/QueryIdleProcessorCycleTime
base\queryidleprocessorcycletime.htm
backup
75a5c4cf-ccc7-47ab-a2a9-88051e0a7d06
12/05/2018
QueryIdleProcessorCycleTime, QueryIdleProcessorCycleTime function, base.queryidleprocessorcycletime, realtimeapiset/QueryIdleProcessorCycleTime, winbase/QueryIdleProcessorCycleTime
realtimeapiset.h
Windows.h on Windows 7, Windows Server 2008 Windows Server 2008 R2
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Kernel32.lib
Kernel32.dll
Windows
19H1
QueryIdleProcessorCycleTime
realtimeapiset/QueryIdleProcessorCycleTime
c++
APIRef
kbSyntax
DllExport
Kernel32.dll
API-MS-Win-Core-realtime-l1-1-0.dll
KernelBase.dll
API-MS-Win-DownLevel-Kernel32-l1-1-0.dll
MinKernelBase.dll
API-MS-Win-Core-RealTime-l1-1-1.dll
QueryIdleProcessorCycleTime

QueryIdleProcessorCycleTime function

-description

Retrieves the cycle time for the idle thread of each processor in the system.

On a system with more than 64 processors, this function retrieves the cycle time for the idle thread of each processor in the processor group to which the calling thread is assigned. Use the QueryIdleProcessorCycleTimeEx function to retrieve the cycle time for the idle thread on each logical processor for a specific processor group.

-parameters

-param BufferLength [in, out]

On input, specifies the size of the ProcessorIdleCycleTime buffer, in bytes. This buffer is expected to be 8 times the number of processors in the group.

On output, specifies the number of elements written to the buffer. If the buffer size is not sufficient, the function fails and this parameter receives the required length of the buffer.

-param ProcessorIdleCycleTime [out]

The number of CPU clock cycles used by each idle thread. This buffer must be 8 times the number of processors in the system in size.

-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

To compile an application that uses this function, define _WIN32_WINNT as 0x0600 or later.

-see-also

Processor Groups

QueryIdleProcessorCycleTimeEx

QueryProcessCycleTime

QueryThreadCycleTime