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
DataListHIDP_DATA*out
DataLengthDWORD*inout
PreparsedDataPHIDP_PREPARSED_DATAin
ReportLPSTRout
ReportLengthDWORDin

戻り値の型: 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)。