Expand Minimize

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:  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.

To retrieve the number of CPU clock cycles used by the threads, use the QueryThreadCycleTime function.

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

FILETIME
FileTimeToDosDateTime
FileTimeToLocalFileTime
FileTimeToSystemTime
OpenThread
Process and Thread Functions
Threads

 

 

Community Additions

ADD
Show:
© 2014 Microsoft