ホーム › System.SystemInformation › GetProcessorSystemCycleTime

GetProcessorSystemCycleTime

関数

プロセッサグループのカーネルモード実行サイクル時間を取得する。

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

シグネチャ

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

BOOL GetProcessorSystemCycleTime(
    WORD Group,
    SYSTEM_PROCESSOR_CYCLE_TIME_INFORMATION* Buffer,   // optional
    DWORD* ReturnedLength
);

パラメーター

名前	型	方向	説明
Group	WORD	in	サイクル時間を取得する対象のプロセッサグループ番号。
Buffer	SYSTEM_PROCESSOR_CYCLE_TIME_INFORMATION*	outoptional	グループ内の各プロセッサについて SYSTEM_PROCESSOR_CYCLE_TIME_INFORMATION 構造体を受け取るバッファへのポインター。出力時、この構造体の DWORD64 型の CycleTime メンバーには、1 つのプロセッサのサイクル時間が設定されます。
ReturnedLength	DWORD*	inout	バッファのサイズ (バイト単位)。関数が戻ると、このパラメーターには Buffer に書き込まれたバイト数が格納されます。バッファがデータに対して小さすぎる場合、関数は ERROR_INSUFFICIENT_BUFFER で失敗し、ReturnedLength パラメーターに必要なバッファサイズを設定します。

戻り値の型: BOOL

公式ドキュメント

指定したプロセッサグループ内の各プロセッサが、アクティブになってから遅延プロシージャ呼び出し (DPC) および割り込みサービスルーチン (ISR) の実行に費やしたサイクル時間を取得します。

戻り値

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

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

エラー値が ERROR_INSUFFICIENT_BUFFER の場合、ReturnedLength パラメーターには必要なバッファサイズが格納されます。

解説(Remarks)

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0601 以降として定義します。詳細については、 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 GetProcessorSystemCycleTime(
    WORD Group,
    SYSTEM_PROCESSOR_CYCLE_TIME_INFORMATION* Buffer,   // optional
    DWORD* ReturnedLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetProcessorSystemCycleTime(
    ushort Group,   // WORD
    IntPtr Buffer,   // SYSTEM_PROCESSOR_CYCLE_TIME_INFORMATION* optional, out
    ref uint ReturnedLength   // DWORD* in/out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetProcessorSystemCycleTime(
    Group As UShort,   ' WORD
    Buffer As IntPtr,   ' SYSTEM_PROCESSOR_CYCLE_TIME_INFORMATION* optional, out
    ByRef ReturnedLength As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Group : WORD
' Buffer : SYSTEM_PROCESSOR_CYCLE_TIME_INFORMATION* optional, out
' ReturnedLength : DWORD* in/out
Declare PtrSafe Function GetProcessorSystemCycleTime Lib "kernel32" ( _
    ByVal Group As Integer, _
    ByVal Buffer As LongPtr, _
    ByRef ReturnedLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetProcessorSystemCycleTime = ctypes.windll.kernel32.GetProcessorSystemCycleTime
GetProcessorSystemCycleTime.restype = wintypes.BOOL
GetProcessorSystemCycleTime.argtypes = [
    ctypes.c_ushort,  # Group : WORD
    ctypes.c_void_p,  # Buffer : SYSTEM_PROCESSOR_CYCLE_TIME_INFORMATION* optional, out
    ctypes.POINTER(wintypes.DWORD),  # ReturnedLength : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetProcessorSystemCycleTime = Fiddle::Function.new(
  lib['GetProcessorSystemCycleTime'],
  [
    -Fiddle::TYPE_SHORT,  # Group : WORD
    Fiddle::TYPE_VOIDP,  # Buffer : SYSTEM_PROCESSOR_CYCLE_TIME_INFORMATION* optional, out
    Fiddle::TYPE_VOIDP,  # ReturnedLength : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetProcessorSystemCycleTime(
        Group: u16,  // WORD
        Buffer: *mut SYSTEM_PROCESSOR_CYCLE_TIME_INFORMATION,  // SYSTEM_PROCESSOR_CYCLE_TIME_INFORMATION* optional, out
        ReturnedLength: *mut u32  // DWORD* in/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 GetProcessorSystemCycleTime(ushort Group, IntPtr Buffer, ref uint ReturnedLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetProcessorSystemCycleTime' -Namespace Win32 -PassThru
# $api::GetProcessorSystemCycleTime(Group, Buffer, ReturnedLength)

#uselib "KERNEL32.dll"
#func global GetProcessorSystemCycleTime "GetProcessorSystemCycleTime" sptr, sptr, sptr
; GetProcessorSystemCycleTime Group, varptr(Buffer), varptr(ReturnedLength)   ; 戻り値は stat
; Group : WORD -> "sptr"
; Buffer : SYSTEM_PROCESSOR_CYCLE_TIME_INFORMATION* optional, out -> "sptr"
; ReturnedLength : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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