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

GetRawInputData

関数
Raw Inputデバイスからの生入力データを取得する。
DLLUSER32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD GetRawInputData(
    HRAWINPUT hRawInput,
    RAW_INPUT_DATA_COMMAND_FLAGS uiCommand,
    void* pData,   // optional
    DWORD* pcbSize,
    DWORD cbSizeHeader
);

パラメーター

名前方向説明
hRawInputHRAWINPUTinWM_INPUTメッセージのLPARAMで渡されるRAW入力データのハンドル(HRAWINPUT)。
uiCommandRAW_INPUT_DATA_COMMAND_FLAGSin取得するデータの種類。RID_INPUT(データ本体)またはRID_HEADER(ヘッダのみ)。
pDatavoid*outoptionalRAW入力データを受け取るバッファ。NULL指定で必要サイズを取得できる。
pcbSizeDWORD*inoutpDataバッファのサイズ(バイト数)を入出力するポインタ。
cbSizeHeaderDWORDinRAWINPUTHEADER構造体のサイズ(バイト数)。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD GetRawInputData(
    HRAWINPUT hRawInput,
    RAW_INPUT_DATA_COMMAND_FLAGS uiCommand,
    void* pData,   // optional
    DWORD* pcbSize,
    DWORD cbSizeHeader
);
[DllImport("USER32.dll", ExactSpelling = true)]
static extern uint GetRawInputData(
    IntPtr hRawInput,   // HRAWINPUT
    uint uiCommand,   // RAW_INPUT_DATA_COMMAND_FLAGS
    IntPtr pData,   // void* optional, out
    ref uint pcbSize,   // DWORD* in/out
    uint cbSizeHeader   // DWORD
);
<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function GetRawInputData(
    hRawInput As IntPtr,   ' HRAWINPUT
    uiCommand As UInteger,   ' RAW_INPUT_DATA_COMMAND_FLAGS
    pData As IntPtr,   ' void* optional, out
    ByRef pcbSize As UInteger,   ' DWORD* in/out
    cbSizeHeader As UInteger   ' DWORD
) As UInteger
End Function
' hRawInput : HRAWINPUT
' uiCommand : RAW_INPUT_DATA_COMMAND_FLAGS
' pData : void* optional, out
' pcbSize : DWORD* in/out
' cbSizeHeader : DWORD
Declare PtrSafe Function GetRawInputData Lib "user32" ( _
    ByVal hRawInput As LongPtr, _
    ByVal uiCommand As Long, _
    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

GetRawInputData = ctypes.windll.user32.GetRawInputData
GetRawInputData.restype = wintypes.DWORD
GetRawInputData.argtypes = [
    wintypes.HANDLE,  # hRawInput : HRAWINPUT
    wintypes.DWORD,  # uiCommand : RAW_INPUT_DATA_COMMAND_FLAGS
    ctypes.POINTER(None),  # pData : void* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbSize : DWORD* in/out
    wintypes.DWORD,  # cbSizeHeader : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetRawInputData = Fiddle::Function.new(
  lib['GetRawInputData'],
  [
    Fiddle::TYPE_VOIDP,  # hRawInput : HRAWINPUT
    -Fiddle::TYPE_INT,  # uiCommand : RAW_INPUT_DATA_COMMAND_FLAGS
    Fiddle::TYPE_VOIDP,  # pData : void* optional, out
    Fiddle::TYPE_VOIDP,  # pcbSize : DWORD* in/out
    -Fiddle::TYPE_INT,  # cbSizeHeader : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn GetRawInputData(
        hRawInput: *mut core::ffi::c_void,  // HRAWINPUT
        uiCommand: u32,  // RAW_INPUT_DATA_COMMAND_FLAGS
        pData: *mut (),  // void* 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")]
public static extern uint GetRawInputData(IntPtr hRawInput, uint uiCommand, IntPtr pData, ref uint pcbSize, uint cbSizeHeader);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetRawInputData' -Namespace Win32 -PassThru
# $api::GetRawInputData(hRawInput, uiCommand, pData, pcbSize, cbSizeHeader)
#uselib "USER32.dll"
#func global GetRawInputData "GetRawInputData" sptr, sptr, sptr, sptr, sptr
; GetRawInputData hRawInput, uiCommand, pData, varptr(pcbSize), cbSizeHeader   ; 戻り値は stat
; hRawInput : HRAWINPUT -> "sptr"
; uiCommand : RAW_INPUT_DATA_COMMAND_FLAGS -> "sptr"
; pData : void* optional, out -> "sptr"
; pcbSize : DWORD* in/out -> "sptr"
; cbSizeHeader : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global GetRawInputData "GetRawInputData" sptr, int, sptr, var, int
; res = GetRawInputData(hRawInput, uiCommand, pData, pcbSize, cbSizeHeader)
; hRawInput : HRAWINPUT -> "sptr"
; uiCommand : RAW_INPUT_DATA_COMMAND_FLAGS -> "int"
; pData : void* optional, out -> "sptr"
; pcbSize : DWORD* in/out -> "var"
; cbSizeHeader : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetRawInputData(HRAWINPUT hRawInput, RAW_INPUT_DATA_COMMAND_FLAGS uiCommand, void* pData, DWORD* pcbSize, DWORD cbSizeHeader)
#uselib "USER32.dll"
#cfunc global GetRawInputData "GetRawInputData" intptr, int, intptr, var, int
; res = GetRawInputData(hRawInput, uiCommand, pData, pcbSize, cbSizeHeader)
; hRawInput : HRAWINPUT -> "intptr"
; uiCommand : RAW_INPUT_DATA_COMMAND_FLAGS -> "int"
; pData : void* optional, out -> "intptr"
; pcbSize : DWORD* in/out -> "var"
; cbSizeHeader : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetRawInputData = user32.NewProc("GetRawInputData")
)

// hRawInput (HRAWINPUT), uiCommand (RAW_INPUT_DATA_COMMAND_FLAGS), pData (void* optional, out), pcbSize (DWORD* in/out), cbSizeHeader (DWORD)
r1, _, err := procGetRawInputData.Call(
	uintptr(hRawInput),
	uintptr(uiCommand),
	uintptr(pData),
	uintptr(pcbSize),
	uintptr(cbSizeHeader),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetRawInputData(
  hRawInput: THandle;   // HRAWINPUT
  uiCommand: DWORD;   // RAW_INPUT_DATA_COMMAND_FLAGS
  pData: Pointer;   // void* optional, out
  pcbSize: Pointer;   // DWORD* in/out
  cbSizeHeader: DWORD   // DWORD
): DWORD; stdcall;
  external 'USER32.dll' name 'GetRawInputData';
result := DllCall("USER32\GetRawInputData"
    , "Ptr", hRawInput   ; HRAWINPUT
    , "UInt", uiCommand   ; RAW_INPUT_DATA_COMMAND_FLAGS
    , "Ptr", pData   ; void* optional, out
    , "Ptr", pcbSize   ; DWORD* in/out
    , "UInt", cbSizeHeader   ; DWORD
    , "UInt")   ; return: DWORD
●GetRawInputData(hRawInput, uiCommand, pData, pcbSize, cbSizeHeader) = DLL("USER32.dll", "dword GetRawInputData(void*, dword, void*, void*, dword)")
# 呼び出し: GetRawInputData(hRawInput, uiCommand, pData, pcbSize, cbSizeHeader)
# hRawInput : HRAWINPUT -> "void*"
# uiCommand : RAW_INPUT_DATA_COMMAND_FLAGS -> "dword"
# pData : void* 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 GetRawInputData(
    hRawInput: ?*anyopaque, // HRAWINPUT
    uiCommand: u32, // RAW_INPUT_DATA_COMMAND_FLAGS
    pData: ?*anyopaque, // void* optional, out
    pcbSize: [*c]u32, // DWORD* in/out
    cbSizeHeader: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc GetRawInputData(
    hRawInput: pointer,  # HRAWINPUT
    uiCommand: uint32,  # RAW_INPUT_DATA_COMMAND_FLAGS
    pData: pointer,  # void* optional, out
    pcbSize: ptr uint32,  # DWORD* in/out
    cbSizeHeader: uint32  # DWORD
): uint32 {.importc: "GetRawInputData", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
uint GetRawInputData(
    void* hRawInput,   // HRAWINPUT
    uint uiCommand,   // RAW_INPUT_DATA_COMMAND_FLAGS
    void* pData,   // void* optional, out
    uint* pcbSize,   // DWORD* in/out
    uint cbSizeHeader   // DWORD
);
ccall((:GetRawInputData, "USER32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32, Ptr{Cvoid}, Ptr{UInt32}, UInt32),
      hRawInput, uiCommand, pData, pcbSize, cbSizeHeader)
# hRawInput : HRAWINPUT -> Ptr{Cvoid}
# uiCommand : RAW_INPUT_DATA_COMMAND_FLAGS -> UInt32
# pData : void* optional, out -> Ptr{Cvoid}
# pcbSize : DWORD* in/out -> Ptr{UInt32}
# cbSizeHeader : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetRawInputData(
    void* hRawInput,
    uint32_t uiCommand,
    void* pData,
    uint32_t* pcbSize,
    uint32_t cbSizeHeader);
]]
local user32 = ffi.load("user32")
-- user32.GetRawInputData(hRawInput, uiCommand, pData, pcbSize, cbSizeHeader)
-- hRawInput : HRAWINPUT
-- uiCommand : RAW_INPUT_DATA_COMMAND_FLAGS
-- pData : void* 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 GetRawInputData = lib.func('__stdcall', 'GetRawInputData', 'uint32_t', ['void *', 'uint32_t', 'void *', 'uint32_t *', 'uint32_t']);
// GetRawInputData(hRawInput, uiCommand, pData, pcbSize, cbSizeHeader)
// hRawInput : HRAWINPUT -> 'void *'
// uiCommand : RAW_INPUT_DATA_COMMAND_FLAGS -> 'uint32_t'
// pData : void* optional, out -> 'void *'
// pcbSize : DWORD* in/out -> 'uint32_t *'
// cbSizeHeader : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetRawInputData: { parameters: ["pointer", "u32", "pointer", "pointer", "u32"], result: "u32" },
});
// lib.symbols.GetRawInputData(hRawInput, uiCommand, pData, pcbSize, cbSizeHeader)
// hRawInput : HRAWINPUT -> "pointer"
// uiCommand : RAW_INPUT_DATA_COMMAND_FLAGS -> "u32"
// pData : void* optional, out -> "pointer"
// pcbSize : DWORD* in/out -> "pointer"
// cbSizeHeader : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetRawInputData(
    void* hRawInput,
    uint32_t uiCommand,
    void* pData,
    uint32_t* pcbSize,
    uint32_t cbSizeHeader);
C, "USER32.dll");
// $ffi->GetRawInputData(hRawInput, uiCommand, pData, pcbSize, cbSizeHeader);
// hRawInput : HRAWINPUT
// uiCommand : RAW_INPUT_DATA_COMMAND_FLAGS
// pData : void* 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 GetRawInputData(
        Pointer hRawInput,   // HRAWINPUT
        int uiCommand,   // RAW_INPUT_DATA_COMMAND_FLAGS
        Pointer pData,   // void* optional, out
        IntByReference pcbSize,   // DWORD* in/out
        int cbSizeHeader   // DWORD
    );
}
@[Link("user32")]
lib LibUSER32
  fun GetRawInputData = GetRawInputData(
    hRawInput : Void*,   # HRAWINPUT
    uiCommand : UInt32,   # RAW_INPUT_DATA_COMMAND_FLAGS
    pData : Void*,   # void* 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 GetRawInputDataNative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Void>, Pointer<Uint32>, Uint32);
typedef GetRawInputDataDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Uint32>, int);
final GetRawInputData = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetRawInputDataNative, GetRawInputDataDart>('GetRawInputData');
// hRawInput : HRAWINPUT -> Pointer<Void>
// uiCommand : RAW_INPUT_DATA_COMMAND_FLAGS -> Uint32
// pData : void* optional, out -> Pointer<Void>
// pcbSize : DWORD* in/out -> Pointer<Uint32>
// cbSizeHeader : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetRawInputData(
  hRawInput: THandle;   // HRAWINPUT
  uiCommand: DWORD;   // RAW_INPUT_DATA_COMMAND_FLAGS
  pData: Pointer;   // void* optional, out
  pcbSize: Pointer;   // DWORD* in/out
  cbSizeHeader: DWORD   // DWORD
): DWORD; stdcall;
  external 'USER32.dll' name 'GetRawInputData';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getrawinputdata =
  foreign "GetRawInputData"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> (ptr uint32_t) @-> uint32_t @-> returning uint32_t)
(* hRawInput : HRAWINPUT -> (ptr void) *)
(* uiCommand : RAW_INPUT_DATA_COMMAND_FLAGS -> uint32_t *)
(* pData : void* 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 ("GetRawInputData" get-raw-input-data :convention :stdcall) :uint32
  (h-raw-input :pointer)   ; HRAWINPUT
  (ui-command :uint32)   ; RAW_INPUT_DATA_COMMAND_FLAGS
  (p-data :pointer)   ; void* 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 $GetRawInputData = Win32::API::More->new('USER32',
    'DWORD GetRawInputData(HANDLE hRawInput, DWORD uiCommand, LPVOID pData, LPVOID pcbSize, DWORD cbSizeHeader)');
# my $ret = $GetRawInputData->Call($hRawInput, $uiCommand, $pData, $pcbSize, $cbSizeHeader);
# hRawInput : HRAWINPUT -> HANDLE
# uiCommand : RAW_INPUT_DATA_COMMAND_FLAGS -> DWORD
# pData : void* optional, out -> LPVOID
# pcbSize : DWORD* in/out -> LPVOID
# cbSizeHeader : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型