ホーム › System.Performance › QueryPerformanceCounter

QueryPerformanceCounter

関数

高分解能パフォーマンスカウンタの現在値を取得する。

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

シグネチャ

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

BOOL QueryPerformanceCounter(
    LONGLONG* lpPerformanceCount
);

パラメーター

名前	型	方向	説明
lpPerformanceCount	LONGLONG*	out	現在のパフォーマンスカウンター値 (カウント単位) を受け取る変数へのポインター。

戻り値の型: BOOL

公式ドキュメント

パフォーマンスカウンターの現在値を取得します。これは時間間隔の測定に使用できる高分解能 (<1µs) のタイムスタンプです。

戻り値

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

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには GetLastError を呼び出します。Windows XP 以降が動作するシステムでは、有効なパラメーターが渡された場合この関数は常に成功するため、0 を返すことはありません。

解説(Remarks)

この関数とその使用方法の詳細については、Acquiring high-resolution time stamps を参照してください。

例

// Gets the current number of ticks from QueryPerformanceCounter. Throws an
// exception if the call to QueryPerformanceCounter fails.
static inline int64_t GetTicks()
{
    LARGE_INTEGER ticks;
    if (!QueryPerformanceCounter(&ticks))
    {
        winrt::throw_last_error();
    }
    return ticks.QuadPart;
}

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

各言語での呼び出し定義

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

BOOL QueryPerformanceCounter(
    LONGLONG* lpPerformanceCount
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool QueryPerformanceCounter(
    out long lpPerformanceCount   // LONGLONG* out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function QueryPerformanceCounter(
    <Out> ByRef lpPerformanceCount As Long   ' LONGLONG* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpPerformanceCount : LONGLONG* out
Declare PtrSafe Function QueryPerformanceCounter Lib "kernel32" ( _
    ByRef lpPerformanceCount As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

QueryPerformanceCounter = ctypes.windll.kernel32.QueryPerformanceCounter
QueryPerformanceCounter.restype = wintypes.BOOL
QueryPerformanceCounter.argtypes = [
    ctypes.POINTER(ctypes.c_longlong),  # lpPerformanceCount : LONGLONG* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
QueryPerformanceCounter = Fiddle::Function.new(
  lib['QueryPerformanceCounter'],
  [
    Fiddle::TYPE_VOIDP,  # lpPerformanceCount : LONGLONG* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn QueryPerformanceCounter(
        lpPerformanceCount: *mut i64  // LONGLONG* 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 QueryPerformanceCounter(out long lpPerformanceCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_QueryPerformanceCounter' -Namespace Win32 -PassThru
# $api::QueryPerformanceCounter(lpPerformanceCount)

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

出力引数:

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