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

QueryPerformanceFrequency

関数
高分解能パフォーマンスカウンタの周波数を取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL QueryPerformanceFrequency(
    LONGLONG* lpFrequency
);

パラメーター

名前方向説明
lpFrequencyLONGLONG*out現在のパフォーマンスカウンターの周波数(1 秒あたりのカウント数)を受け取る変数へのポインターです。インストールされているハードウェアが高分解能パフォーマンスカウンターをサポートしていない場合、このパラメーターは 0 になることがあります(Windows XP 以降が動作するシステムでは発生しません)。

戻り値の型: BOOL

公式ドキュメント

パフォーマンスカウンターの周波数を取得します。

戻り値

インストールされているハードウェアが高分解能パフォーマンスカウンターをサポートしている場合、戻り値は 0 以外になります。

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

解説(Remarks)

この関数とその使用方法の詳細については、高分解能タイムスタンプの取得を参照してください。

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

各言語での呼び出し定義

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

BOOL QueryPerformanceFrequency(
    LONGLONG* lpFrequency
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool QueryPerformanceFrequency(
    out long lpFrequency   // LONGLONG* out
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function QueryPerformanceFrequency(
    <Out> ByRef lpFrequency As Long   ' LONGLONG* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpFrequency : LONGLONG* out
Declare PtrSafe Function QueryPerformanceFrequency Lib "kernel32" ( _
    ByRef lpFrequency As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

QueryPerformanceFrequency = ctypes.windll.kernel32.QueryPerformanceFrequency
QueryPerformanceFrequency.restype = wintypes.BOOL
QueryPerformanceFrequency.argtypes = [
    ctypes.POINTER(ctypes.c_longlong),  # lpFrequency : LONGLONG* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
QueryPerformanceFrequency = Fiddle::Function.new(
  lib['QueryPerformanceFrequency'],
  [
    Fiddle::TYPE_VOIDP,  # lpFrequency : LONGLONG* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn QueryPerformanceFrequency(
        lpFrequency: *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 QueryPerformanceFrequency(out long lpFrequency);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_QueryPerformanceFrequency' -Namespace Win32 -PassThru
# $api::QueryPerformanceFrequency(lpFrequency)
#uselib "KERNEL32.dll"
#func global QueryPerformanceFrequency "QueryPerformanceFrequency" sptr
; QueryPerformanceFrequency varptr(lpFrequency)   ; 戻り値は stat
; lpFrequency : LONGLONG* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global QueryPerformanceFrequency "QueryPerformanceFrequency" var
; res = QueryPerformanceFrequency(lpFrequency)
; lpFrequency : LONGLONG* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL QueryPerformanceFrequency(LONGLONG* lpFrequency)
#uselib "KERNEL32.dll"
#cfunc global QueryPerformanceFrequency "QueryPerformanceFrequency" var
; res = QueryPerformanceFrequency(lpFrequency)
; lpFrequency : LONGLONG* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procQueryPerformanceFrequency = kernel32.NewProc("QueryPerformanceFrequency")
)

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

extern "kernel32" fn QueryPerformanceFrequency(
    lpFrequency: [*c]i64 // LONGLONG* out
) callconv(std.os.windows.WINAPI) i32;
proc QueryPerformanceFrequency(
    lpFrequency: ptr int64  # LONGLONG* out
): int32 {.importc: "QueryPerformanceFrequency", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int QueryPerformanceFrequency(
    long* lpFrequency   // LONGLONG* out
);
ccall((:QueryPerformanceFrequency, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Int64},),
      lpFrequency)
# lpFrequency : LONGLONG* out -> Ptr{Int64}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t QueryPerformanceFrequency(
    int64_t* lpFrequency);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.QueryPerformanceFrequency(lpFrequency)
-- lpFrequency : LONGLONG* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const QueryPerformanceFrequency = lib.func('__stdcall', 'QueryPerformanceFrequency', 'int32_t', ['int64_t *']);
// QueryPerformanceFrequency(lpFrequency)
// lpFrequency : LONGLONG* out -> 'int64_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  QueryPerformanceFrequency: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.QueryPerformanceFrequency(lpFrequency)
// lpFrequency : LONGLONG* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t QueryPerformanceFrequency(
    int64_t* lpFrequency);
C, "KERNEL32.dll");
// $ffi->QueryPerformanceFrequency(lpFrequency);
// lpFrequency : LONGLONG* 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 QueryPerformanceFrequency(
        LongByReference lpFrequency   // LONGLONG* out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun QueryPerformanceFrequency = QueryPerformanceFrequency(
    lpFrequency : Int64*   # LONGLONG* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

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

関連項目

公式の関連項目