GetThreadTimes Function
GetThreadTimes Function

Retrieves timing information for the specified thread.

Syntax

BOOL WINAPI GetThreadTimes(
  __in   HANDLE hThread,
  __out  LPFILETIME lpCreationTime,
  __out  LPFILETIME lpExitTime,
  __out  LPFILETIME lpKernelTime,
  __out  LPFILETIME lpUserTime
);


Parameters

hThread [in]

A handle to the thread whose timing information is sought. 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/2000:  The handle must have the THREAD_QUERY_INFORMATION access right.
lpCreationTime [out]

A pointer to a FILETIME structure that receives the creation time of the thread.

lpExitTime [out]

A pointer to a FILETIME structure that receives the exit time of the thread. If the thread has not exited, the content of this structure is undefined.

lpKernelTime [out]

A pointer to a FILETIME structure that receives the amount of time that the thread has executed in kernel mode.

lpUserTime [out]

A pointer to a FILETIME structure that receives the amount of time that the thread has executed in user mode.

Return Value

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

All times are expressed using FILETIME data structures. Such a structure contains two 32-bit values that combine to form a 64-bit count of 100-nanosecond time units.

Thread creation and exit times are points in time expressed as the amount of time that has elapsed since midnight on January 1, 1601 at Greenwich, England. There are several functions that an application can use to convert such values to more generally useful forms; see Time Functions.

Thread kernel mode and user mode times are amounts of time. For example, if a thread has spent one second in kernel mode, this function will fill the FILETIME structure specified by lpKernelTime with a 64-bit value of ten million. That is the number of 100-nanosecond units in one second.

Requirements

Minimum supported client

Windows 2000 Professional

Minimum supported server

Windows 2000 Server

Header

Winbase.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See Also

FILETIME
FileTimeToDosDateTime
FileTimeToLocalFileTime
FileTimeToSystemTime
OpenThread
Process and Thread Functions
Threads

 

 

Send comments about this topic to Microsoft

Build date: 2/4/2010

Community Content

Sample timing constraints
Added by:Chief Scientist

Note that the method by which kernel and user time is measured and accumulated for each thread makes it necessary for one to take samples over a long period of time (seconds) for the output of this routine to be accurate. The granularity of the measurement used here is in the 10mS arena, so sample times over 100 times that should yield sufficiently accurate results for most users.

If you're looking for profiler-type operation (sampling hundreds if not thousands of times in a second), this is NOT the method to use.

In other words, do not:

loop
   sleep( 30 )
   GetThreadTimes()
End loop

Instead do this, or the equivalent (this is SIMPLIFIED code -- Sleep( 1000 ) is not usually a good idea)

loop
sleep( 1000 )
GetThreadTimes()
End loop

-e

vb.net syntax
Added by:dmex
<DllImport("kernel32.dll", CharSet:=CharSet.Auto, SetLastError:=True)> _
Public Shared Function GetThreadTimes(ByVal handle As IntPtr, <Out> ByRef creation As Long, <Out> ByRef [exit] As Long, <Out> ByRef kernel As Long, <Out> ByRef user As Long) As Boolean End Function
C# syntax
Added by:dmex
[DllImport("kernel32.dll", CharSet=CharSet.Auto, SetLastError=true)]
public static extern bool GetThreadTimes(IntPtr handle, out long creation, out long exit, out long kernel, out long user);
© 2010 Microsoft Corporation. All rights reserved.   Terms of Use | Trademarks | Privacy Statement
Page view tracker
Rate the Lightweight library
x
Lightweight builds on ScriptFree (loband) by adding features you've requested: a SearchBox and default code language selection.
Do you like the SearchBox?
Do you like the tabbed code blocks?
How useful is this topic?
Tell us more.
Thanks
x
You're helping to improve MSDN Online.
Feedback
Switch View
Classic
Lightweight Beta
ScriptFree
Switch View