GetThreadTimes

関数

指定スレッドの作成・終了・カーネル・ユーザー時間を取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL GetThreadTimes(
    HANDLE hThread,
    FILETIME* lpCreationTime,
    FILETIME* lpExitTime,
    FILETIME* lpKernelTime,
    FILETIME* lpUserTime
);

パラメーター

名前	型	方向	説明
hThread	HANDLE	in	タイミング情報を取得するスレッドのハンドルです。このハンドルには THREAD_QUERY_INFORMATION または THREAD_QUERY_LIMITED_INFORMATION アクセス権が必要です。詳細については、 Thread Security and Access Rights を参照してください。 Windows Server 2003 および Windows XP: ハンドルには THREAD_QUERY_INFORMATION アクセス権が必要です。
lpCreationTime	FILETIME*	out	スレッドの作成時刻を受け取る FILETIME 構造体へのポインターです。
lpExitTime	FILETIME*	out	スレッドの終了時刻を受け取る FILETIME 構造体へのポインターです。スレッドが終了していない場合、この構造体の内容は未定義です。
lpKernelTime	FILETIME*	out	スレッドがカーネルモードで実行された時間を受け取る FILETIME 構造体へのポインターです。
lpUserTime	FILETIME*	out	スレッドがユーザーモードで実行された時間を受け取る FILETIME 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

指定したスレッドのタイミング情報を取得します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

すべての時刻は FILETIME データ構造体を使用して表現されます。この構造体には 2 つの 32 ビット値が含まれ、これらが組み合わさって 100 ナノ秒単位の 64 ビットカウントを形成します。

スレッドの作成時刻と終了時刻は、イギリスのグリニッジ時間で 1601 年 1 月 1 日午前 0 時からの経過時間として表現される時点です。これらの値をより一般的に使いやすい形式に変換するために、アプリケーションが利用できるいくつかの関数があります。 Time Functions を参照してください。

スレッドのカーネルモード時間とユーザーモード時間は、時間の長さを表します。たとえば、スレッドがカーネルモードで 1 秒間を費やした場合、この関数は lpKernelTime で指定された FILETIME 構造体を 64 ビット値の 1,000 万で埋めます。これは 1 秒間に含まれる 100 ナノ秒単位の数です。

スレッドが使用した CPU クロックサイクル数を取得するには、QueryThreadCycleTime 関数を使用します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL GetThreadTimes(
    HANDLE hThread,
    FILETIME* lpCreationTime,
    FILETIME* lpExitTime,
    FILETIME* lpKernelTime,
    FILETIME* lpUserTime
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetThreadTimes(
    IntPtr hThread,   // HANDLE
    IntPtr lpCreationTime,   // FILETIME* out
    IntPtr lpExitTime,   // FILETIME* out
    IntPtr lpKernelTime,   // FILETIME* out
    IntPtr lpUserTime   // FILETIME* out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetThreadTimes(
    hThread As IntPtr,   ' HANDLE
    lpCreationTime As IntPtr,   ' FILETIME* out
    lpExitTime As IntPtr,   ' FILETIME* out
    lpKernelTime As IntPtr,   ' FILETIME* out
    lpUserTime As IntPtr   ' FILETIME* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hThread : HANDLE
' lpCreationTime : FILETIME* out
' lpExitTime : FILETIME* out
' lpKernelTime : FILETIME* out
' lpUserTime : FILETIME* out
Declare PtrSafe Function GetThreadTimes Lib "kernel32" ( _
    ByVal hThread As LongPtr, _
    ByVal lpCreationTime As LongPtr, _
    ByVal lpExitTime As LongPtr, _
    ByVal lpKernelTime As LongPtr, _
    ByVal lpUserTime As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetThreadTimes = ctypes.windll.kernel32.GetThreadTimes
GetThreadTimes.restype = wintypes.BOOL
GetThreadTimes.argtypes = [
    wintypes.HANDLE,  # hThread : HANDLE
    ctypes.c_void_p,  # lpCreationTime : FILETIME* out
    ctypes.c_void_p,  # lpExitTime : FILETIME* out
    ctypes.c_void_p,  # lpKernelTime : FILETIME* out
    ctypes.c_void_p,  # lpUserTime : FILETIME* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetThreadTimes = Fiddle::Function.new(
  lib['GetThreadTimes'],
  [
    Fiddle::TYPE_VOIDP,  # hThread : HANDLE
    Fiddle::TYPE_VOIDP,  # lpCreationTime : FILETIME* out
    Fiddle::TYPE_VOIDP,  # lpExitTime : FILETIME* out
    Fiddle::TYPE_VOIDP,  # lpKernelTime : FILETIME* out
    Fiddle::TYPE_VOIDP,  # lpUserTime : FILETIME* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetThreadTimes(
        hThread: *mut core::ffi::c_void,  // HANDLE
        lpCreationTime: *mut FILETIME,  // FILETIME* out
        lpExitTime: *mut FILETIME,  // FILETIME* out
        lpKernelTime: *mut FILETIME,  // FILETIME* out
        lpUserTime: *mut FILETIME  // FILETIME* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool GetThreadTimes(IntPtr hThread, IntPtr lpCreationTime, IntPtr lpExitTime, IntPtr lpKernelTime, IntPtr lpUserTime);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetThreadTimes' -Namespace Win32 -PassThru
# $api::GetThreadTimes(hThread, lpCreationTime, lpExitTime, lpKernelTime, lpUserTime)

#uselib "KERNEL32.dll"
#func global GetThreadTimes "GetThreadTimes" sptr, sptr, sptr, sptr, sptr
; GetThreadTimes hThread, varptr(lpCreationTime), varptr(lpExitTime), varptr(lpKernelTime), varptr(lpUserTime)   ; 戻り値は stat
; hThread : HANDLE -> "sptr"
; lpCreationTime : FILETIME* out -> "sptr"
; lpExitTime : FILETIME* out -> "sptr"
; lpKernelTime : FILETIME* out -> "sptr"
; lpUserTime : FILETIME* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetThreadTimes "GetThreadTimes" sptr, var, var, var, var
; res = GetThreadTimes(hThread, lpCreationTime, lpExitTime, lpKernelTime, lpUserTime)
; hThread : HANDLE -> "sptr"
; lpCreationTime : FILETIME* out -> "var"
; lpExitTime : FILETIME* out -> "var"
; lpKernelTime : FILETIME* out -> "var"
; lpUserTime : FILETIME* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetThreadTimes "GetThreadTimes" sptr, sptr, sptr, sptr, sptr
; res = GetThreadTimes(hThread, varptr(lpCreationTime), varptr(lpExitTime), varptr(lpKernelTime), varptr(lpUserTime))
; hThread : HANDLE -> "sptr"
; lpCreationTime : FILETIME* out -> "sptr"
; lpExitTime : FILETIME* out -> "sptr"
; lpKernelTime : FILETIME* out -> "sptr"
; lpUserTime : FILETIME* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。