Win32 API 日本語リファレンス
ホームUI.Input › GetRawInputBuffer

GetRawInputBuffer

関数
バッファ内の複数のRaw Inputデータをまとめて取得する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD GetRawInputBuffer(
    RAWINPUT* pData,   // optional
    DWORD* pcbSize,
    DWORD cbSizeHeader
);

パラメーター

名前方向説明
pDataRAWINPUT*outoptionalRAWINPUT構造体の配列を受け取るバッファ。NULLで必要サイズ取得。
pcbSizeDWORD*inoutpDataバッファのサイズ(バイト数)を入出力するポインタ。
cbSizeHeaderDWORDinRAWINPUTHEADER構造体のサイズ(バイト数)。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD GetRawInputBuffer(
    RAWINPUT* pData,   // optional
    DWORD* pcbSize,
    DWORD cbSizeHeader
);
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint GetRawInputBuffer(
    IntPtr pData,   // RAWINPUT* optional, out
    ref uint pcbSize,   // DWORD* in/out
    uint cbSizeHeader   // DWORD
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetRawInputBuffer(
    pData As IntPtr,   ' RAWINPUT* optional, out
    ByRef pcbSize As UInteger,   ' DWORD* in/out
    cbSizeHeader As UInteger   ' DWORD
) As UInteger
End Function
' pData : RAWINPUT* optional, out
' pcbSize : DWORD* in/out
' cbSizeHeader : DWORD
Declare PtrSafe Function GetRawInputBuffer Lib "user32" ( _
    ByVal pData As LongPtr, _
    ByRef pcbSize As Long, _
    ByVal cbSizeHeader As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetRawInputBuffer = ctypes.windll.user32.GetRawInputBuffer
GetRawInputBuffer.restype = wintypes.DWORD
GetRawInputBuffer.argtypes = [
    ctypes.c_void_p,  # pData : RAWINPUT* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbSize : DWORD* in/out
    wintypes.DWORD,  # cbSizeHeader : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetRawInputBuffer = Fiddle::Function.new(
  lib['GetRawInputBuffer'],
  [
    Fiddle::TYPE_VOIDP,  # pData : RAWINPUT* optional, out
    Fiddle::TYPE_VOIDP,  # pcbSize : DWORD* in/out
    -Fiddle::TYPE_INT,  # cbSizeHeader : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn GetRawInputBuffer(
        pData: *mut RAWINPUT,  // RAWINPUT* optional, out
        pcbSize: *mut u32,  // DWORD* in/out
        cbSizeHeader: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", SetLastError = true)]
public static extern uint GetRawInputBuffer(IntPtr pData, ref uint pcbSize, uint cbSizeHeader);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetRawInputBuffer' -Namespace Win32 -PassThru
# $api::GetRawInputBuffer(pData, pcbSize, cbSizeHeader)
#uselib "USER32.dll"
#func global GetRawInputBuffer "GetRawInputBuffer" sptr, sptr, sptr
; GetRawInputBuffer varptr(pData), varptr(pcbSize), cbSizeHeader   ; 戻り値は stat
; pData : RAWINPUT* optional, out -> "sptr"
; pcbSize : DWORD* in/out -> "sptr"
; cbSizeHeader : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global GetRawInputBuffer "GetRawInputBuffer" var, var, int
; res = GetRawInputBuffer(pData, pcbSize, cbSizeHeader)
; pData : RAWINPUT* optional, out -> "var"
; pcbSize : DWORD* in/out -> "var"
; cbSizeHeader : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetRawInputBuffer(RAWINPUT* pData, DWORD* pcbSize, DWORD cbSizeHeader)
#uselib "USER32.dll"
#cfunc global GetRawInputBuffer "GetRawInputBuffer" var, var, int
; res = GetRawInputBuffer(pData, pcbSize, cbSizeHeader)
; pData : RAWINPUT* optional, out -> "var"
; pcbSize : DWORD* in/out -> "var"
; cbSizeHeader : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetRawInputBuffer = user32.NewProc("GetRawInputBuffer")
)

// pData (RAWINPUT* optional, out), pcbSize (DWORD* in/out), cbSizeHeader (DWORD)
r1, _, err := procGetRawInputBuffer.Call(
	uintptr(pData),
	uintptr(pcbSize),
	uintptr(cbSizeHeader),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetRawInputBuffer(
  pData: Pointer;   // RAWINPUT* optional, out
  pcbSize: Pointer;   // DWORD* in/out
  cbSizeHeader: DWORD   // DWORD
): DWORD; stdcall;
  external 'USER32.dll' name 'GetRawInputBuffer';
result := DllCall("USER32\GetRawInputBuffer"
    , "Ptr", pData   ; RAWINPUT* optional, out
    , "Ptr", pcbSize   ; DWORD* in/out
    , "UInt", cbSizeHeader   ; DWORD
    , "UInt")   ; return: DWORD
●GetRawInputBuffer(pData, pcbSize, cbSizeHeader) = DLL("USER32.dll", "dword GetRawInputBuffer(void*, void*, dword)")
# 呼び出し: GetRawInputBuffer(pData, pcbSize, cbSizeHeader)
# pData : RAWINPUT* optional, out -> "void*"
# pcbSize : DWORD* in/out -> "void*"
# cbSizeHeader : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef GetRawInputBufferNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>, Uint32);
typedef GetRawInputBufferDart = int Function(Pointer<Void>, Pointer<Uint32>, int);
final GetRawInputBuffer = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetRawInputBufferNative, GetRawInputBufferDart>('GetRawInputBuffer');
// pData : RAWINPUT* optional, out -> Pointer<Void>
// pcbSize : DWORD* in/out -> Pointer<Uint32>
// cbSizeHeader : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetRawInputBuffer(
  pData: Pointer;   // RAWINPUT* optional, out
  pcbSize: Pointer;   // DWORD* in/out
  cbSizeHeader: DWORD   // DWORD
): DWORD; stdcall;
  external 'USER32.dll' name 'GetRawInputBuffer';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetRawInputBuffer"
  c_GetRawInputBuffer :: Ptr () -> Ptr Word32 -> Word32 -> IO Word32
-- pData : RAWINPUT* optional, out -> Ptr ()
-- pcbSize : DWORD* in/out -> Ptr Word32
-- cbSizeHeader : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getrawinputbuffer =
  foreign "GetRawInputBuffer"
    ((ptr void) @-> (ptr uint32_t) @-> uint32_t @-> returning uint32_t)
(* pData : RAWINPUT* optional, out -> (ptr void) *)
(* pcbSize : DWORD* in/out -> (ptr uint32_t) *)
(* cbSizeHeader : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("GetRawInputBuffer" get-raw-input-buffer :convention :stdcall) :uint32
  (p-data :pointer)   ; RAWINPUT* optional, out
  (pcb-size :pointer)   ; DWORD* in/out
  (cb-size-header :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetRawInputBuffer = Win32::API::More->new('USER32',
    'DWORD GetRawInputBuffer(LPVOID pData, LPVOID pcbSize, DWORD cbSizeHeader)');
# my $ret = $GetRawInputBuffer->Call($pData, $pcbSize, $cbSizeHeader);
# pData : RAWINPUT* optional, out -> LPVOID
# pcbSize : DWORD* in/out -> LPVOID
# cbSizeHeader : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型