GetSystemTimes

関数

システム全体のアイドル・カーネル・ユーザー時間を取得する。

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

シグネチャ

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

BOOL GetSystemTimes(
    FILETIME* lpIdleTime,   // optional
    FILETIME* lpKernelTime,   // optional
    FILETIME* lpUserTime   // optional
);

パラメーター

名前	型	方向	説明
lpIdleTime	FILETIME*	outoptional	システムがアイドル状態であった時間を「ティック」単位で受け取る FILETIME 構造体へのポインター。
lpKernelTime	FILETIME*	outoptional	システムが Kernel モードで実行に費やした時間(全プロセッサ上の全プロセス内の全スレッドを含む)を「ティック」単位で受け取る FILETIME 構造体へのポインター。この時間値には、システムがアイドル状態であった時間も含まれます。
lpUserTime	FILETIME*	outoptional	システムが User モードで実行に費やした時間(全プロセッサ上の全プロセス内の全スレッドを含む)を「ティック」単位で受け取る FILETIME 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

システムのタイミング情報を取得します。マルチプロセッサシステムでは、返される値は全プロセッサにわたる指定された時間の合計になります。

戻り値

関数が成功した場合、戻り値は 0 以外です。

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

解説(Remarks)

マルチプロセッサシステム(プロセッサが 64 個以下)では、返される値は全プロセッサにわたる指定された時間を「ティック」単位で合計したものです。

メモ

64 個を超えるプロセッサを持つシステムでは、返される値は呼び出し元スレッドが属する主プロセッサグループに対する指定された時間の合計です(Processor Groups を参照)。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0501 以降として定義します。詳細については、Using the Windows Headers を参照してください。

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

各言語での呼び出し定義

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

BOOL GetSystemTimes(
    FILETIME* lpIdleTime,   // optional
    FILETIME* lpKernelTime,   // optional
    FILETIME* lpUserTime   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetSystemTimes(
    IntPtr lpIdleTime,   // FILETIME* optional, out
    IntPtr lpKernelTime,   // FILETIME* optional, out
    IntPtr lpUserTime   // FILETIME* optional, out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetSystemTimes(
    lpIdleTime As IntPtr,   ' FILETIME* optional, out
    lpKernelTime As IntPtr,   ' FILETIME* optional, out
    lpUserTime As IntPtr   ' FILETIME* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpIdleTime : FILETIME* optional, out
' lpKernelTime : FILETIME* optional, out
' lpUserTime : FILETIME* optional, out
Declare PtrSafe Function GetSystemTimes Lib "kernel32" ( _
    ByVal lpIdleTime 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

GetSystemTimes = ctypes.windll.kernel32.GetSystemTimes
GetSystemTimes.restype = wintypes.BOOL
GetSystemTimes.argtypes = [
    ctypes.c_void_p,  # lpIdleTime : FILETIME* optional, out
    ctypes.c_void_p,  # lpKernelTime : FILETIME* optional, out
    ctypes.c_void_p,  # lpUserTime : FILETIME* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetSystemTimes = Fiddle::Function.new(
  lib['GetSystemTimes'],
  [
    Fiddle::TYPE_VOIDP,  # lpIdleTime : FILETIME* optional, out
    Fiddle::TYPE_VOIDP,  # lpKernelTime : FILETIME* optional, out
    Fiddle::TYPE_VOIDP,  # lpUserTime : FILETIME* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetSystemTimes(
        lpIdleTime: *mut FILETIME,  // FILETIME* optional, out
        lpKernelTime: *mut FILETIME,  // FILETIME* optional, out
        lpUserTime: *mut FILETIME  // FILETIME* optional, 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 GetSystemTimes(IntPtr lpIdleTime, IntPtr lpKernelTime, IntPtr lpUserTime);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetSystemTimes' -Namespace Win32 -PassThru
# $api::GetSystemTimes(lpIdleTime, lpKernelTime, lpUserTime)

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

出力引数:

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