Win32 API 日本語リファレンス
ホーム › System.WindowsProgramming › QueryUnbiasedInterruptTime

QueryUnbiasedInterruptTime

関数
スリープ時間を除いた割り込み時間を取得する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

BOOL QueryUnbiasedInterruptTime(
    ULONGLONG* UnbiasedTime
);

パラメーター

名前型方向説明
UnbiasedTimeULONGLONG*out

TBD

- lpUnbiasedInterruptTime [out]

バイアスなし割り込み時間カウントを 100 ナノ秒のシステム時間単位で受け取る ULONGLONG へのポインター。秒単位に変換するには、1000 万 (1e7) で除算します (1 秒は 1e9 ナノ秒であるため、1 秒は 1e7 個の 100 ナノ秒に相当します)。

戻り値の型: BOOL

公式ドキュメント

現在のバイアスなし割り込み時間カウント (unbiased interrupt-time count) を 100 ナノ秒単位で取得します。バイアスなし割り込み時間カウントには、システムがスリープまたは休止状態で費やした時間は含まれません。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。null のパラメーターを指定して呼び出されたために関数が失敗した場合、戻り値は 0 です。

解説(Remarks)

割り込み時間カウントはシステムの起動時に 0 から始まり、クロック割り込みごとにクロック ティックの長さだけ加算されます。クロック ティックの正確な長さは基盤となるハードウェアに依存し、システムによって異なる場合があります。

QueryUnbiasedInterruptTime 関数が取得する割り込み時間カウントは、システムが動作状態にある時間のみを反映します。したがって、この割り込み時間カウントは、システムがスリープまたは休止状態で費やした時間によって "バイアス" されることはありません。システムは、スリープ中に期限が切れるはずだった相対タイマーを復帰時に直ちに満了させるなど、一部の操作にはバイアスありの割り込み時間を使用します。

システム時刻とは異なり、割り込み時間カウントはユーザーや Windows タイム サービスによる調整の影響を受けません。アプリケーションは、割り込み時間カウントを使用して、システム時刻よりも細かい時間を計測できます。割り込み時間カウントよりも高い精度が必要なアプリケーションでは、高分解能タイマーを使用してください。高分解能タイマーの周波数を取得するには QueryPerformanceFrequency 関数を、カウンターの値を取得するには QueryPerformanceCounter 関数を使用します。

timeBeginPeriod 関数および timeEndPeriod 関数で設定されるタイマーの分解能は、QueryUnbiasedInterruptTime 関数の分解能に影響します。ただし、タイマーの分解能を上げることは推奨されません。プロセッサが省電力状態に移行できなくなることで、システム全体のパフォーマンスが低下し、システムの消費電力が増加する可能性があるためです。代わりに、アプリケーションでは高分解能タイマーを使用してください。

注意 QueryUnbiasedInterruptTime 関数は、Windows のデバッグ ("チェック済み") ビルドでは異なる結果を返します。これは、割り込み時間カウントとティック カウントが約 49 日進められるためです。これにより、システムが長時間実行されるまで発生しないようなバグを特定しやすくなります。
この関数を使用するアプリケーションをコンパイルするには、_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 QueryUnbiasedInterruptTime(
    ULONGLONG* UnbiasedTime
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool QueryUnbiasedInterruptTime(
    out ulong UnbiasedTime   // ULONGLONG* out
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function QueryUnbiasedInterruptTime(
    <Out> ByRef UnbiasedTime As ULong   ' ULONGLONG* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' UnbiasedTime : ULONGLONG* out
Declare PtrSafe Function QueryUnbiasedInterruptTime Lib "kernel32" ( _
    ByRef UnbiasedTime As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

QueryUnbiasedInterruptTime = ctypes.windll.kernel32.QueryUnbiasedInterruptTime
QueryUnbiasedInterruptTime.restype = wintypes.BOOL
QueryUnbiasedInterruptTime.argtypes = [
    ctypes.POINTER(ctypes.c_ulonglong),  # UnbiasedTime : ULONGLONG* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
QueryUnbiasedInterruptTime = Fiddle::Function.new(
  lib['QueryUnbiasedInterruptTime'],
  [
    Fiddle::TYPE_VOIDP,  # UnbiasedTime : ULONGLONG* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn QueryUnbiasedInterruptTime(
        UnbiasedTime: *mut u64  // ULONGLONG* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool QueryUnbiasedInterruptTime(out ulong UnbiasedTime);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_QueryUnbiasedInterruptTime' -Namespace Win32 -PassThru
# $api::QueryUnbiasedInterruptTime(UnbiasedTime)
#uselib "KERNEL32.dll"
#func global QueryUnbiasedInterruptTime "QueryUnbiasedInterruptTime" sptr
; QueryUnbiasedInterruptTime varptr(UnbiasedTime)   ; 戻り値は stat
; UnbiasedTime : ULONGLONG* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global QueryUnbiasedInterruptTime "QueryUnbiasedInterruptTime" var
; res = QueryUnbiasedInterruptTime(UnbiasedTime)
; UnbiasedTime : ULONGLONG* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL QueryUnbiasedInterruptTime(ULONGLONG* UnbiasedTime)
#uselib "KERNEL32.dll"
#cfunc global QueryUnbiasedInterruptTime "QueryUnbiasedInterruptTime" var
; res = QueryUnbiasedInterruptTime(UnbiasedTime)
; UnbiasedTime : ULONGLONG* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procQueryUnbiasedInterruptTime = kernel32.NewProc("QueryUnbiasedInterruptTime")
)

// UnbiasedTime (ULONGLONG* out)
r1, _, err := procQueryUnbiasedInterruptTime.Call(
	uintptr(UnbiasedTime),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function QueryUnbiasedInterruptTime(
  UnbiasedTime: Pointer   // ULONGLONG* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'QueryUnbiasedInterruptTime';
result := DllCall("KERNEL32\QueryUnbiasedInterruptTime"
    , "Ptr", UnbiasedTime   ; ULONGLONG* out
    , "Int")   ; return: BOOL
●QueryUnbiasedInterruptTime(UnbiasedTime) = DLL("KERNEL32.dll", "bool QueryUnbiasedInterruptTime(void*)")
# 呼び出し: QueryUnbiasedInterruptTime(UnbiasedTime)
# UnbiasedTime : ULONGLONG* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn QueryUnbiasedInterruptTime(
    UnbiasedTime: [*c]u64 // ULONGLONG* out
) callconv(std.os.windows.WINAPI) i32;
proc QueryUnbiasedInterruptTime(
    UnbiasedTime: ptr uint64  # ULONGLONG* out
): int32 {.importc: "QueryUnbiasedInterruptTime", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int QueryUnbiasedInterruptTime(
    ulong* UnbiasedTime   // ULONGLONG* out
);
ccall((:QueryUnbiasedInterruptTime, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{UInt64},),
      UnbiasedTime)
# UnbiasedTime : ULONGLONG* out -> Ptr{UInt64}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t QueryUnbiasedInterruptTime(
    uint64_t* UnbiasedTime);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.QueryUnbiasedInterruptTime(UnbiasedTime)
-- UnbiasedTime : ULONGLONG* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const QueryUnbiasedInterruptTime = lib.func('__stdcall', 'QueryUnbiasedInterruptTime', 'int32_t', ['uint64_t *']);
// QueryUnbiasedInterruptTime(UnbiasedTime)
// UnbiasedTime : ULONGLONG* out -> 'uint64_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  QueryUnbiasedInterruptTime: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.QueryUnbiasedInterruptTime(UnbiasedTime)
// UnbiasedTime : ULONGLONG* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t QueryUnbiasedInterruptTime(
    uint64_t* UnbiasedTime);
C, "KERNEL32.dll");
// $ffi->QueryUnbiasedInterruptTime(UnbiasedTime);
// UnbiasedTime : ULONGLONG* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean QueryUnbiasedInterruptTime(
        LongByReference UnbiasedTime   // ULONGLONG* out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun QueryUnbiasedInterruptTime = QueryUnbiasedInterruptTime(
    UnbiasedTime : UInt64*   # ULONGLONG* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef QueryUnbiasedInterruptTimeNative = Int32 Function(Pointer<Uint64>);
typedef QueryUnbiasedInterruptTimeDart = int Function(Pointer<Uint64>);
final QueryUnbiasedInterruptTime = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<QueryUnbiasedInterruptTimeNative, QueryUnbiasedInterruptTimeDart>('QueryUnbiasedInterruptTime');
// UnbiasedTime : ULONGLONG* out -> Pointer<Uint64>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function QueryUnbiasedInterruptTime(
  UnbiasedTime: Pointer   // ULONGLONG* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'QueryUnbiasedInterruptTime';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "QueryUnbiasedInterruptTime"
  c_QueryUnbiasedInterruptTime :: Ptr Word64 -> IO CInt
-- UnbiasedTime : ULONGLONG* out -> Ptr Word64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let queryunbiasedinterrupttime =
  foreign "QueryUnbiasedInterruptTime"
    ((ptr uint64_t) @-> returning int32_t)
(* UnbiasedTime : ULONGLONG* out -> (ptr uint64_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("QueryUnbiasedInterruptTime" query-unbiased-interrupt-time :convention :stdcall) :int32
  (unbiased-time :pointer))   ; ULONGLONG* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $QueryUnbiasedInterruptTime = Win32::API::More->new('KERNEL32',
    'BOOL QueryUnbiasedInterruptTime(LPVOID UnbiasedTime)');
# my $ret = $QueryUnbiasedInterruptTime->Call($UnbiasedTime);
# UnbiasedTime : ULONGLONG* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目