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

HidP_GetData

関数
HIDレポートから現在のデータ値を取得する。
DLLHID.dll呼出規約winapi

シグネチャ

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

NTSTATUS HidP_GetData(
    HIDP_REPORT_TYPE ReportType,
    HIDP_DATA* DataList,
    DWORD* DataLength,
    PHIDP_PREPARSED_DATA PreparsedData,
    LPSTR Report,
    DWORD ReportLength
);

パラメーター

名前方向説明
ReportTypeHIDP_REPORT_TYPEin対象のレポート種別をHIDP_REPORT_TYPE(Input/Output/Feature)で指定する。
DataListHIDP_DATA*outレポートから取得したデータ項目配列(HIDP_DATA)を受け取るバッファへのポインタを指定する。
DataLengthDWORD*inout入出力で配列の容量を指定し、取得した項目数を受け取るDWORDへのポインタを指定する。
PreparsedDataPHIDP_PREPARSED_DATAinHidD_GetPreparsedDataで取得した前解析データへのポインタを指定する。
ReportLPSTRout読み取り元のレポートバッファへのポインタを指定する。
ReportLengthDWORDinReportバッファのバイト長を指定する。

戻り値の型: NTSTATUS

各言語での呼び出し定義

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

NTSTATUS HidP_GetData(
    HIDP_REPORT_TYPE ReportType,
    HIDP_DATA* DataList,
    DWORD* DataLength,
    PHIDP_PREPARSED_DATA PreparsedData,
    LPSTR Report,
    DWORD ReportLength
);
[DllImport("HID.dll", ExactSpelling = true)]
static extern int HidP_GetData(
    int ReportType,   // HIDP_REPORT_TYPE
    IntPtr DataList,   // HIDP_DATA* out
    ref uint DataLength,   // DWORD* in/out
    IntPtr PreparsedData,   // PHIDP_PREPARSED_DATA
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder Report,   // LPSTR out
    uint ReportLength   // DWORD
);
<DllImport("HID.dll", ExactSpelling:=True)>
Public Shared Function HidP_GetData(
    ReportType As Integer,   ' HIDP_REPORT_TYPE
    DataList As IntPtr,   ' HIDP_DATA* out
    ByRef DataLength As UInteger,   ' DWORD* in/out
    PreparsedData As IntPtr,   ' PHIDP_PREPARSED_DATA
    <MarshalAs(UnmanagedType.LPStr)> Report As System.Text.StringBuilder,   ' LPSTR out
    ReportLength As UInteger   ' DWORD
) As Integer
End Function
' ReportType : HIDP_REPORT_TYPE
' DataList : HIDP_DATA* out
' DataLength : DWORD* in/out
' PreparsedData : PHIDP_PREPARSED_DATA
' Report : LPSTR out
' ReportLength : DWORD
Declare PtrSafe Function HidP_GetData Lib "hid" ( _
    ByVal ReportType As Long, _
    ByVal DataList As LongPtr, _
    ByRef DataLength As Long, _
    ByVal PreparsedData As LongPtr, _
    ByVal Report As String, _
    ByVal ReportLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HidP_GetData = ctypes.windll.hid.HidP_GetData
HidP_GetData.restype = ctypes.c_int
HidP_GetData.argtypes = [
    ctypes.c_int,  # ReportType : HIDP_REPORT_TYPE
    ctypes.c_void_p,  # DataList : HIDP_DATA* out
    ctypes.POINTER(wintypes.DWORD),  # DataLength : DWORD* in/out
    ctypes.c_ssize_t,  # PreparsedData : PHIDP_PREPARSED_DATA
    wintypes.LPSTR,  # Report : LPSTR out
    wintypes.DWORD,  # ReportLength : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HID.dll')
HidP_GetData = Fiddle::Function.new(
  lib['HidP_GetData'],
  [
    Fiddle::TYPE_INT,  # ReportType : HIDP_REPORT_TYPE
    Fiddle::TYPE_VOIDP,  # DataList : HIDP_DATA* out
    Fiddle::TYPE_VOIDP,  # DataLength : DWORD* in/out
    Fiddle::TYPE_INTPTR_T,  # PreparsedData : PHIDP_PREPARSED_DATA
    Fiddle::TYPE_VOIDP,  # Report : LPSTR out
    -Fiddle::TYPE_INT,  # ReportLength : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "hid")]
extern "system" {
    fn HidP_GetData(
        ReportType: i32,  // HIDP_REPORT_TYPE
        DataList: *mut HIDP_DATA,  // HIDP_DATA* out
        DataLength: *mut u32,  // DWORD* in/out
        PreparsedData: isize,  // PHIDP_PREPARSED_DATA
        Report: *mut u8,  // LPSTR out
        ReportLength: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("HID.dll")]
public static extern int HidP_GetData(int ReportType, IntPtr DataList, ref uint DataLength, IntPtr PreparsedData, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder Report, uint ReportLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HID_HidP_GetData' -Namespace Win32 -PassThru
# $api::HidP_GetData(ReportType, DataList, DataLength, PreparsedData, Report, ReportLength)
#uselib "HID.dll"
#func global HidP_GetData "HidP_GetData" sptr, sptr, sptr, sptr, sptr, sptr
; HidP_GetData ReportType, varptr(DataList), varptr(DataLength), PreparsedData, varptr(Report), ReportLength   ; 戻り値は stat
; ReportType : HIDP_REPORT_TYPE -> "sptr"
; DataList : HIDP_DATA* out -> "sptr"
; DataLength : DWORD* in/out -> "sptr"
; PreparsedData : PHIDP_PREPARSED_DATA -> "sptr"
; Report : LPSTR out -> "sptr"
; ReportLength : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "HID.dll"
#cfunc global HidP_GetData "HidP_GetData" int, var, var, sptr, var, int
; res = HidP_GetData(ReportType, DataList, DataLength, PreparsedData, Report, ReportLength)
; ReportType : HIDP_REPORT_TYPE -> "int"
; DataList : HIDP_DATA* out -> "var"
; DataLength : DWORD* in/out -> "var"
; PreparsedData : PHIDP_PREPARSED_DATA -> "sptr"
; Report : LPSTR out -> "var"
; ReportLength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; NTSTATUS HidP_GetData(HIDP_REPORT_TYPE ReportType, HIDP_DATA* DataList, DWORD* DataLength, PHIDP_PREPARSED_DATA PreparsedData, LPSTR Report, DWORD ReportLength)
#uselib "HID.dll"
#cfunc global HidP_GetData "HidP_GetData" int, var, var, intptr, var, int
; res = HidP_GetData(ReportType, DataList, DataLength, PreparsedData, Report, ReportLength)
; ReportType : HIDP_REPORT_TYPE -> "int"
; DataList : HIDP_DATA* out -> "var"
; DataLength : DWORD* in/out -> "var"
; PreparsedData : PHIDP_PREPARSED_DATA -> "intptr"
; Report : LPSTR out -> "var"
; ReportLength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	hid = windows.NewLazySystemDLL("HID.dll")
	procHidP_GetData = hid.NewProc("HidP_GetData")
)

// ReportType (HIDP_REPORT_TYPE), DataList (HIDP_DATA* out), DataLength (DWORD* in/out), PreparsedData (PHIDP_PREPARSED_DATA), Report (LPSTR out), ReportLength (DWORD)
r1, _, err := procHidP_GetData.Call(
	uintptr(ReportType),
	uintptr(DataList),
	uintptr(DataLength),
	uintptr(PreparsedData),
	uintptr(Report),
	uintptr(ReportLength),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // NTSTATUS
function HidP_GetData(
  ReportType: Integer;   // HIDP_REPORT_TYPE
  DataList: Pointer;   // HIDP_DATA* out
  DataLength: Pointer;   // DWORD* in/out
  PreparsedData: NativeInt;   // PHIDP_PREPARSED_DATA
  Report: PAnsiChar;   // LPSTR out
  ReportLength: DWORD   // DWORD
): Integer; stdcall;
  external 'HID.dll' name 'HidP_GetData';
result := DllCall("HID\HidP_GetData"
    , "Int", ReportType   ; HIDP_REPORT_TYPE
    , "Ptr", DataList   ; HIDP_DATA* out
    , "Ptr", DataLength   ; DWORD* in/out
    , "Ptr", PreparsedData   ; PHIDP_PREPARSED_DATA
    , "Ptr", Report   ; LPSTR out
    , "UInt", ReportLength   ; DWORD
    , "Int")   ; return: NTSTATUS
●HidP_GetData(ReportType, DataList, DataLength, PreparsedData, Report, ReportLength) = DLL("HID.dll", "int HidP_GetData(int, void*, void*, int, char*, dword)")
# 呼び出し: HidP_GetData(ReportType, DataList, DataLength, PreparsedData, Report, ReportLength)
# ReportType : HIDP_REPORT_TYPE -> "int"
# DataList : HIDP_DATA* out -> "void*"
# DataLength : DWORD* in/out -> "void*"
# PreparsedData : PHIDP_PREPARSED_DATA -> "int"
# Report : LPSTR out -> "char*"
# ReportLength : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef HidP_GetDataNative = Int32 Function(Int32, Pointer<Void>, Pointer<Uint32>, IntPtr, Pointer<Utf8>, Uint32);
typedef HidP_GetDataDart = int Function(int, Pointer<Void>, Pointer<Uint32>, int, Pointer<Utf8>, int);
final HidP_GetData = DynamicLibrary.open('HID.dll')
    .lookupFunction<HidP_GetDataNative, HidP_GetDataDart>('HidP_GetData');
// ReportType : HIDP_REPORT_TYPE -> Int32
// DataList : HIDP_DATA* out -> Pointer<Void>
// DataLength : DWORD* in/out -> Pointer<Uint32>
// PreparsedData : PHIDP_PREPARSED_DATA -> IntPtr
// Report : LPSTR out -> Pointer<Utf8>
// ReportLength : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HidP_GetData(
  ReportType: Integer;   // HIDP_REPORT_TYPE
  DataList: Pointer;   // HIDP_DATA* out
  DataLength: Pointer;   // DWORD* in/out
  PreparsedData: NativeInt;   // PHIDP_PREPARSED_DATA
  Report: PAnsiChar;   // LPSTR out
  ReportLength: DWORD   // DWORD
): Integer; stdcall;
  external 'HID.dll' name 'HidP_GetData';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HidP_GetData"
  c_HidP_GetData :: Int32 -> Ptr () -> Ptr Word32 -> CIntPtr -> CString -> Word32 -> IO Int32
-- ReportType : HIDP_REPORT_TYPE -> Int32
-- DataList : HIDP_DATA* out -> Ptr ()
-- DataLength : DWORD* in/out -> Ptr Word32
-- PreparsedData : PHIDP_PREPARSED_DATA -> CIntPtr
-- Report : LPSTR out -> CString
-- ReportLength : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let hidp_getdata =
  foreign "HidP_GetData"
    (int32_t @-> (ptr void) @-> (ptr uint32_t) @-> intptr_t @-> string @-> uint32_t @-> returning int32_t)
(* ReportType : HIDP_REPORT_TYPE -> int32_t *)
(* DataList : HIDP_DATA* out -> (ptr void) *)
(* DataLength : DWORD* in/out -> (ptr uint32_t) *)
(* PreparsedData : PHIDP_PREPARSED_DATA -> intptr_t *)
(* Report : LPSTR out -> string *)
(* ReportLength : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library hid (t "HID.dll"))
(cffi:use-foreign-library hid)

(cffi:defcfun ("HidP_GetData" hid-p-get-data :convention :stdcall) :int32
  (report-type :int32)   ; HIDP_REPORT_TYPE
  (data-list :pointer)   ; HIDP_DATA* out
  (data-length :pointer)   ; DWORD* in/out
  (preparsed-data :int64)   ; PHIDP_PREPARSED_DATA
  (report :pointer)   ; LPSTR out
  (report-length :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HidP_GetData = Win32::API::More->new('HID',
    'int HidP_GetData(int ReportType, LPVOID DataList, LPVOID DataLength, LPARAM PreparsedData, LPSTR Report, DWORD ReportLength)');
# my $ret = $HidP_GetData->Call($ReportType, $DataList, $DataLength, $PreparsedData, $Report, $ReportLength);
# ReportType : HIDP_REPORT_TYPE -> int
# DataList : HIDP_DATA* out -> LPVOID
# DataLength : DWORD* in/out -> LPVOID
# PreparsedData : PHIDP_PREPARSED_DATA -> LPARAM
# Report : LPSTR out -> LPSTR
# ReportLength : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型