Win32 API 日本語リファレンス
ホームDevices.Usb › WinUsb_GetCurrentFrameNumber

WinUsb_GetCurrentFrameNumber

関数
USBバスの現在のフレーム番号とタイムスタンプを取得する。
DLLWINUSB.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

BOOL WinUsb_GetCurrentFrameNumber(
    WINUSB_INTERFACE_HANDLE InterfaceHandle,
    DWORD* CurrentFrameNumber,
    LONGLONG* TimeStamp
);

パラメーター

名前方向説明
InterfaceHandleWINUSB_INTERFACE_HANDLEin現在のフレーム番号を取得する対象のWinUSBインターフェイスハンドル。
CurrentFrameNumberDWORD*out現在のUSBフレーム番号を受け取る出力先ポインタ。
TimeStampLONGLONG*outフレーム番号取得時刻(QPC値)を受け取る出力先ポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

WinUsb_GetCurrentFrameNumber = ctypes.windll.winusb.WinUsb_GetCurrentFrameNumber
WinUsb_GetCurrentFrameNumber.restype = wintypes.BOOL
WinUsb_GetCurrentFrameNumber.argtypes = [
    wintypes.HANDLE,  # InterfaceHandle : WINUSB_INTERFACE_HANDLE
    ctypes.POINTER(wintypes.DWORD),  # CurrentFrameNumber : DWORD* out
    ctypes.POINTER(ctypes.c_longlong),  # TimeStamp : LONGLONG* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	winusb = windows.NewLazySystemDLL("WINUSB.dll")
	procWinUsb_GetCurrentFrameNumber = winusb.NewProc("WinUsb_GetCurrentFrameNumber")
)

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

extern "winusb" fn WinUsb_GetCurrentFrameNumber(
    InterfaceHandle: ?*anyopaque, // WINUSB_INTERFACE_HANDLE
    CurrentFrameNumber: [*c]u32, // DWORD* out
    TimeStamp: [*c]i64 // LONGLONG* out
) callconv(std.os.windows.WINAPI) i32;
proc WinUsb_GetCurrentFrameNumber(
    InterfaceHandle: pointer,  # WINUSB_INTERFACE_HANDLE
    CurrentFrameNumber: ptr uint32,  # DWORD* out
    TimeStamp: ptr int64  # LONGLONG* out
): int32 {.importc: "WinUsb_GetCurrentFrameNumber", stdcall, dynlib: "WINUSB.dll".}
pragma(lib, "winusb");
extern(Windows)
int WinUsb_GetCurrentFrameNumber(
    void* InterfaceHandle,   // WINUSB_INTERFACE_HANDLE
    uint* CurrentFrameNumber,   // DWORD* out
    long* TimeStamp   // LONGLONG* out
);
ccall((:WinUsb_GetCurrentFrameNumber, "WINUSB.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{UInt32}, Ptr{Int64}),
      InterfaceHandle, CurrentFrameNumber, TimeStamp)
# InterfaceHandle : WINUSB_INTERFACE_HANDLE -> Ptr{Cvoid}
# CurrentFrameNumber : DWORD* out -> Ptr{UInt32}
# TimeStamp : LONGLONG* out -> Ptr{Int64}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WinUsb_GetCurrentFrameNumber(
    void* InterfaceHandle,
    uint32_t* CurrentFrameNumber,
    int64_t* TimeStamp);
]]
local winusb = ffi.load("winusb")
-- winusb.WinUsb_GetCurrentFrameNumber(InterfaceHandle, CurrentFrameNumber, TimeStamp)
-- InterfaceHandle : WINUSB_INTERFACE_HANDLE
-- CurrentFrameNumber : DWORD* out
-- TimeStamp : LONGLONG* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINUSB.dll');
const WinUsb_GetCurrentFrameNumber = lib.func('__stdcall', 'WinUsb_GetCurrentFrameNumber', 'int32_t', ['void *', 'uint32_t *', 'int64_t *']);
// WinUsb_GetCurrentFrameNumber(InterfaceHandle, CurrentFrameNumber, TimeStamp)
// InterfaceHandle : WINUSB_INTERFACE_HANDLE -> 'void *'
// CurrentFrameNumber : DWORD* out -> 'uint32_t *'
// TimeStamp : LONGLONG* out -> 'int64_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINUSB.dll", {
  WinUsb_GetCurrentFrameNumber: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WinUsb_GetCurrentFrameNumber(InterfaceHandle, CurrentFrameNumber, TimeStamp)
// InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "pointer"
// CurrentFrameNumber : DWORD* out -> "pointer"
// TimeStamp : LONGLONG* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WinUsb_GetCurrentFrameNumber(
    void* InterfaceHandle,
    uint32_t* CurrentFrameNumber,
    int64_t* TimeStamp);
C, "WINUSB.dll");
// $ffi->WinUsb_GetCurrentFrameNumber(InterfaceHandle, CurrentFrameNumber, TimeStamp);
// InterfaceHandle : WINUSB_INTERFACE_HANDLE
// CurrentFrameNumber : DWORD* out
// TimeStamp : 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 Winusb extends StdCallLibrary {
    Winusb INSTANCE = Native.load("winusb", Winusb.class);
    boolean WinUsb_GetCurrentFrameNumber(
        Pointer InterfaceHandle,   // WINUSB_INTERFACE_HANDLE
        IntByReference CurrentFrameNumber,   // DWORD* out
        LongByReference TimeStamp   // LONGLONG* out
    );
}
@[Link("winusb")]
lib LibWINUSB
  fun WinUsb_GetCurrentFrameNumber = WinUsb_GetCurrentFrameNumber(
    InterfaceHandle : Void*,   # WINUSB_INTERFACE_HANDLE
    CurrentFrameNumber : UInt32*,   # DWORD* out
    TimeStamp : 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 WinUsb_GetCurrentFrameNumberNative = Int32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Int64>);
typedef WinUsb_GetCurrentFrameNumberDart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Int64>);
final WinUsb_GetCurrentFrameNumber = DynamicLibrary.open('WINUSB.dll')
    .lookupFunction<WinUsb_GetCurrentFrameNumberNative, WinUsb_GetCurrentFrameNumberDart>('WinUsb_GetCurrentFrameNumber');
// InterfaceHandle : WINUSB_INTERFACE_HANDLE -> Pointer<Void>
// CurrentFrameNumber : DWORD* out -> Pointer<Uint32>
// TimeStamp : LONGLONG* out -> Pointer<Int64>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinUsb_GetCurrentFrameNumber(
  InterfaceHandle: THandle;   // WINUSB_INTERFACE_HANDLE
  CurrentFrameNumber: Pointer;   // DWORD* out
  TimeStamp: Pointer   // LONGLONG* out
): BOOL; stdcall;
  external 'WINUSB.dll' name 'WinUsb_GetCurrentFrameNumber';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let winusb_getcurrentframenumber =
  foreign "WinUsb_GetCurrentFrameNumber"
    ((ptr void) @-> (ptr uint32_t) @-> (ptr int64_t) @-> returning int32_t)
(* InterfaceHandle : WINUSB_INTERFACE_HANDLE -> (ptr void) *)
(* CurrentFrameNumber : DWORD* out -> (ptr uint32_t) *)
(* TimeStamp : LONGLONG* out -> (ptr int64_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winusb (t "WINUSB.dll"))
(cffi:use-foreign-library winusb)

(cffi:defcfun ("WinUsb_GetCurrentFrameNumber" win-usb-get-current-frame-number :convention :stdcall) :int32
  (interface-handle :pointer)   ; WINUSB_INTERFACE_HANDLE
  (current-frame-number :pointer)   ; DWORD* out
  (time-stamp :pointer))   ; LONGLONG* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinUsb_GetCurrentFrameNumber = Win32::API::More->new('WINUSB',
    'BOOL WinUsb_GetCurrentFrameNumber(HANDLE InterfaceHandle, LPVOID CurrentFrameNumber, LPVOID TimeStamp)');
# my $ret = $WinUsb_GetCurrentFrameNumber->Call($InterfaceHandle, $CurrentFrameNumber, $TimeStamp);
# InterfaceHandle : WINUSB_INTERFACE_HANDLE -> HANDLE
# CurrentFrameNumber : DWORD* out -> LPVOID
# TimeStamp : LONGLONG* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。