ホーム › Devices.HumanInterfaceDevice › HidP_GetButtonArray

HidP_GetButtonArray

関数

HIDレポートからボタン配列コントロールのデータを取得する。

DLLHID.dll呼出規約winapi

シグネチャ

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

NTSTATUS HidP_GetButtonArray(
    HIDP_REPORT_TYPE ReportType,
    WORD UsagePage,
    WORD LinkCollection,   // optional
    WORD Usage,
    HIDP_BUTTON_ARRAY_DATA* ButtonData,
    WORD* ButtonDataLength,
    PHIDP_PREPARSED_DATA PreparsedData,
    LPSTR Report,
    DWORD ReportLength
);

パラメーター

名前	型	方向	説明
ReportType	HIDP_REPORT_TYPE	in	対象のレポート種別をHIDP_REPORT_TYPE(Input/Output/Feature)で指定する。
UsagePage	WORD	in	取得するボタン配列のユーセージページを指定する。
LinkCollection	WORD	inoptional	対象のリンクコレクションを指定する。0で限定しない。
Usage	WORD	in	対象のボタン配列のユーセージを指定する。
ButtonData	HIDP_BUTTON_ARRAY_DATA*	out	取得したボタン配列データ(HIDP_BUTTON_ARRAY_DATA)を受け取るバッファへのポインタを指定する。
ButtonDataLength	WORD*	inout	入出力で配列の容量を指定し、取得した要素数を受け取るWORDへのポインタを指定する。
PreparsedData	PHIDP_PREPARSED_DATA	in	HidD_GetPreparsedDataで取得した前解析データへのポインタを指定する。
Report	LPSTR	in	読み取り元のレポートバッファへのポインタを指定する。
ReportLength	DWORD	in	Reportバッファのバイト長を指定する。

戻り値の型: NTSTATUS

各言語での呼び出し定義

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

NTSTATUS HidP_GetButtonArray(
    HIDP_REPORT_TYPE ReportType,
    WORD UsagePage,
    WORD LinkCollection,   // optional
    WORD Usage,
    HIDP_BUTTON_ARRAY_DATA* ButtonData,
    WORD* ButtonDataLength,
    PHIDP_PREPARSED_DATA PreparsedData,
    LPSTR Report,
    DWORD ReportLength
);

[DllImport("HID.dll", ExactSpelling = true)]
static extern int HidP_GetButtonArray(
    int ReportType,   // HIDP_REPORT_TYPE
    ushort UsagePage,   // WORD
    ushort LinkCollection,   // WORD optional
    ushort Usage,   // WORD
    IntPtr ButtonData,   // HIDP_BUTTON_ARRAY_DATA* out
    ref ushort ButtonDataLength,   // WORD* in/out
    IntPtr PreparsedData,   // PHIDP_PREPARSED_DATA
    [MarshalAs(UnmanagedType.LPStr)] string Report,   // LPSTR
    uint ReportLength   // DWORD
);

<DllImport("HID.dll", ExactSpelling:=True)>
Public Shared Function HidP_GetButtonArray(
    ReportType As Integer,   ' HIDP_REPORT_TYPE
    UsagePage As UShort,   ' WORD
    LinkCollection As UShort,   ' WORD optional
    Usage As UShort,   ' WORD
    ButtonData As IntPtr,   ' HIDP_BUTTON_ARRAY_DATA* out
    ByRef ButtonDataLength As UShort,   ' WORD* in/out
    PreparsedData As IntPtr,   ' PHIDP_PREPARSED_DATA
    <MarshalAs(UnmanagedType.LPStr)> Report As String,   ' LPSTR
    ReportLength As UInteger   ' DWORD
) As Integer
End Function

' ReportType : HIDP_REPORT_TYPE
' UsagePage : WORD
' LinkCollection : WORD optional
' Usage : WORD
' ButtonData : HIDP_BUTTON_ARRAY_DATA* out
' ButtonDataLength : WORD* in/out
' PreparsedData : PHIDP_PREPARSED_DATA
' Report : LPSTR
' ReportLength : DWORD
Declare PtrSafe Function HidP_GetButtonArray Lib "hid" ( _
    ByVal ReportType As Long, _
    ByVal UsagePage As Integer, _
    ByVal LinkCollection As Integer, _
    ByVal Usage As Integer, _
    ByVal ButtonData As LongPtr, _
    ByRef ButtonDataLength As Integer, _
    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_GetButtonArray = ctypes.windll.hid.HidP_GetButtonArray
HidP_GetButtonArray.restype = ctypes.c_int
HidP_GetButtonArray.argtypes = [
    ctypes.c_int,  # ReportType : HIDP_REPORT_TYPE
    ctypes.c_ushort,  # UsagePage : WORD
    ctypes.c_ushort,  # LinkCollection : WORD optional
    ctypes.c_ushort,  # Usage : WORD
    ctypes.c_void_p,  # ButtonData : HIDP_BUTTON_ARRAY_DATA* out
    ctypes.POINTER(ctypes.c_ushort),  # ButtonDataLength : WORD* in/out
    ctypes.c_ssize_t,  # PreparsedData : PHIDP_PREPARSED_DATA
    wintypes.LPCSTR,  # Report : LPSTR
    wintypes.DWORD,  # ReportLength : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HID.dll')
HidP_GetButtonArray = Fiddle::Function.new(
  lib['HidP_GetButtonArray'],
  [
    Fiddle::TYPE_INT,  # ReportType : HIDP_REPORT_TYPE
    -Fiddle::TYPE_SHORT,  # UsagePage : WORD
    -Fiddle::TYPE_SHORT,  # LinkCollection : WORD optional
    -Fiddle::TYPE_SHORT,  # Usage : WORD
    Fiddle::TYPE_VOIDP,  # ButtonData : HIDP_BUTTON_ARRAY_DATA* out
    Fiddle::TYPE_VOIDP,  # ButtonDataLength : WORD* in/out
    Fiddle::TYPE_INTPTR_T,  # PreparsedData : PHIDP_PREPARSED_DATA
    Fiddle::TYPE_VOIDP,  # Report : LPSTR
    -Fiddle::TYPE_INT,  # ReportLength : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "hid")]
extern "system" {
    fn HidP_GetButtonArray(
        ReportType: i32,  // HIDP_REPORT_TYPE
        UsagePage: u16,  // WORD
        LinkCollection: u16,  // WORD optional
        Usage: u16,  // WORD
        ButtonData: *mut HIDP_BUTTON_ARRAY_DATA,  // HIDP_BUTTON_ARRAY_DATA* out
        ButtonDataLength: *mut u16,  // WORD* in/out
        PreparsedData: isize,  // PHIDP_PREPARSED_DATA
        Report: *mut u8,  // LPSTR
        ReportLength: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("HID.dll")]
public static extern int HidP_GetButtonArray(int ReportType, ushort UsagePage, ushort LinkCollection, ushort Usage, IntPtr ButtonData, ref ushort ButtonDataLength, IntPtr PreparsedData, [MarshalAs(UnmanagedType.LPStr)] string Report, uint ReportLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HID_HidP_GetButtonArray' -Namespace Win32 -PassThru
# $api::HidP_GetButtonArray(ReportType, UsagePage, LinkCollection, Usage, ButtonData, ButtonDataLength, PreparsedData, Report, ReportLength)

#uselib "HID.dll"
#func global HidP_GetButtonArray "HidP_GetButtonArray" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; HidP_GetButtonArray ReportType, UsagePage, LinkCollection, Usage, varptr(ButtonData), varptr(ButtonDataLength), PreparsedData, Report, ReportLength   ; 戻り値は stat
; ReportType : HIDP_REPORT_TYPE -> "sptr"
; UsagePage : WORD -> "sptr"
; LinkCollection : WORD optional -> "sptr"
; Usage : WORD -> "sptr"
; ButtonData : HIDP_BUTTON_ARRAY_DATA* out -> "sptr"
; ButtonDataLength : WORD* in/out -> "sptr"
; PreparsedData : PHIDP_PREPARSED_DATA -> "sptr"
; Report : LPSTR -> "sptr"
; ReportLength : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "HID.dll"
#cfunc global HidP_GetButtonArray "HidP_GetButtonArray" int, int, int, int, var, var, sptr, str, int
; res = HidP_GetButtonArray(ReportType, UsagePage, LinkCollection, Usage, ButtonData, ButtonDataLength, PreparsedData, Report, ReportLength)
; ReportType : HIDP_REPORT_TYPE -> "int"
; UsagePage : WORD -> "int"
; LinkCollection : WORD optional -> "int"
; Usage : WORD -> "int"
; ButtonData : HIDP_BUTTON_ARRAY_DATA* out -> "var"
; ButtonDataLength : WORD* in/out -> "var"
; PreparsedData : PHIDP_PREPARSED_DATA -> "sptr"
; Report : LPSTR -> "str"
; ReportLength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "HID.dll"
#cfunc global HidP_GetButtonArray "HidP_GetButtonArray" int, int, int, int, sptr, sptr, sptr, str, int
; res = HidP_GetButtonArray(ReportType, UsagePage, LinkCollection, Usage, varptr(ButtonData), varptr(ButtonDataLength), PreparsedData, Report, ReportLength)
; ReportType : HIDP_REPORT_TYPE -> "int"
; UsagePage : WORD -> "int"
; LinkCollection : WORD optional -> "int"
; Usage : WORD -> "int"
; ButtonData : HIDP_BUTTON_ARRAY_DATA* out -> "sptr"
; ButtonDataLength : WORD* in/out -> "sptr"
; PreparsedData : PHIDP_PREPARSED_DATA -> "sptr"
; Report : LPSTR -> "str"
; ReportLength : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; NTSTATUS HidP_GetButtonArray(HIDP_REPORT_TYPE ReportType, WORD UsagePage, WORD LinkCollection, WORD Usage, HIDP_BUTTON_ARRAY_DATA* ButtonData, WORD* ButtonDataLength, PHIDP_PREPARSED_DATA PreparsedData, LPSTR Report, DWORD ReportLength)
#uselib "HID.dll"
#cfunc global HidP_GetButtonArray "HidP_GetButtonArray" int, int, int, int, var, var, intptr, str, int
; res = HidP_GetButtonArray(ReportType, UsagePage, LinkCollection, Usage, ButtonData, ButtonDataLength, PreparsedData, Report, ReportLength)
; ReportType : HIDP_REPORT_TYPE -> "int"
; UsagePage : WORD -> "int"
; LinkCollection : WORD optional -> "int"
; Usage : WORD -> "int"
; ButtonData : HIDP_BUTTON_ARRAY_DATA* out -> "var"
; ButtonDataLength : WORD* in/out -> "var"
; PreparsedData : PHIDP_PREPARSED_DATA -> "intptr"
; Report : LPSTR -> "str"
; ReportLength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; NTSTATUS HidP_GetButtonArray(HIDP_REPORT_TYPE ReportType, WORD UsagePage, WORD LinkCollection, WORD Usage, HIDP_BUTTON_ARRAY_DATA* ButtonData, WORD* ButtonDataLength, PHIDP_PREPARSED_DATA PreparsedData, LPSTR Report, DWORD ReportLength)
#uselib "HID.dll"
#cfunc global HidP_GetButtonArray "HidP_GetButtonArray" int, int, int, int, intptr, intptr, intptr, str, int
; res = HidP_GetButtonArray(ReportType, UsagePage, LinkCollection, Usage, varptr(ButtonData), varptr(ButtonDataLength), PreparsedData, Report, ReportLength)
; ReportType : HIDP_REPORT_TYPE -> "int"
; UsagePage : WORD -> "int"
; LinkCollection : WORD optional -> "int"
; Usage : WORD -> "int"
; ButtonData : HIDP_BUTTON_ARRAY_DATA* out -> "intptr"
; ButtonDataLength : WORD* in/out -> "intptr"
; PreparsedData : PHIDP_PREPARSED_DATA -> "intptr"
; Report : LPSTR -> "str"
; ReportLength : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	hid = windows.NewLazySystemDLL("HID.dll")
	procHidP_GetButtonArray = hid.NewProc("HidP_GetButtonArray")
)

// ReportType (HIDP_REPORT_TYPE), UsagePage (WORD), LinkCollection (WORD optional), Usage (WORD), ButtonData (HIDP_BUTTON_ARRAY_DATA* out), ButtonDataLength (WORD* in/out), PreparsedData (PHIDP_PREPARSED_DATA), Report (LPSTR), ReportLength (DWORD)
r1, _, err := procHidP_GetButtonArray.Call(
	uintptr(ReportType),
	uintptr(UsagePage),
	uintptr(LinkCollection),
	uintptr(Usage),
	uintptr(ButtonData),
	uintptr(ButtonDataLength),
	uintptr(PreparsedData),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(Report))),
	uintptr(ReportLength),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // NTSTATUS

function HidP_GetButtonArray(
  ReportType: Integer;   // HIDP_REPORT_TYPE
  UsagePage: Word;   // WORD
  LinkCollection: Word;   // WORD optional
  Usage: Word;   // WORD
  ButtonData: Pointer;   // HIDP_BUTTON_ARRAY_DATA* out
  ButtonDataLength: Pointer;   // WORD* in/out
  PreparsedData: NativeInt;   // PHIDP_PREPARSED_DATA
  Report: PAnsiChar;   // LPSTR
  ReportLength: DWORD   // DWORD
): Integer; stdcall;
  external 'HID.dll' name 'HidP_GetButtonArray';

result := DllCall("HID\HidP_GetButtonArray"
    , "Int", ReportType   ; HIDP_REPORT_TYPE
    , "UShort", UsagePage   ; WORD
    , "UShort", LinkCollection   ; WORD optional
    , "UShort", Usage   ; WORD
    , "Ptr", ButtonData   ; HIDP_BUTTON_ARRAY_DATA* out
    , "Ptr", ButtonDataLength   ; WORD* in/out
    , "Ptr", PreparsedData   ; PHIDP_PREPARSED_DATA
    , "AStr", Report   ; LPSTR
    , "UInt", ReportLength   ; DWORD
    , "Int")   ; return: NTSTATUS

●HidP_GetButtonArray(ReportType, UsagePage, LinkCollection, Usage, ButtonData, ButtonDataLength, PreparsedData, Report, ReportLength) = DLL("HID.dll", "int HidP_GetButtonArray(int, int, int, int, void*, void*, int, char*, dword)")
# 呼び出し: HidP_GetButtonArray(ReportType, UsagePage, LinkCollection, Usage, ButtonData, ButtonDataLength, PreparsedData, Report, ReportLength)
# ReportType : HIDP_REPORT_TYPE -> "int"
# UsagePage : WORD -> "int"
# LinkCollection : WORD optional -> "int"
# Usage : WORD -> "int"
# ButtonData : HIDP_BUTTON_ARRAY_DATA* out -> "void*"
# ButtonDataLength : WORD* in/out -> "void*"
# PreparsedData : PHIDP_PREPARSED_DATA -> "int"
# Report : LPSTR -> "char*"
# ReportLength : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "hid" fn HidP_GetButtonArray(
    ReportType: i32, // HIDP_REPORT_TYPE
    UsagePage: u16, // WORD
    LinkCollection: u16, // WORD optional
    Usage: u16, // WORD
    ButtonData: [*c]HIDP_BUTTON_ARRAY_DATA, // HIDP_BUTTON_ARRAY_DATA* out
    ButtonDataLength: [*c]u16, // WORD* in/out
    PreparsedData: isize, // PHIDP_PREPARSED_DATA
    Report: [*c]const u8, // LPSTR
    ReportLength: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;

proc HidP_GetButtonArray(
    ReportType: int32,  # HIDP_REPORT_TYPE
    UsagePage: uint16,  # WORD
    LinkCollection: uint16,  # WORD optional
    Usage: uint16,  # WORD
    ButtonData: ptr HIDP_BUTTON_ARRAY_DATA,  # HIDP_BUTTON_ARRAY_DATA* out
    ButtonDataLength: ptr uint16,  # WORD* in/out
    PreparsedData: int,  # PHIDP_PREPARSED_DATA
    Report: cstring,  # LPSTR
    ReportLength: uint32  # DWORD
): int32 {.importc: "HidP_GetButtonArray", stdcall, dynlib: "HID.dll".}

pragma(lib, "hid");
extern(Windows)
int HidP_GetButtonArray(
    int ReportType,   // HIDP_REPORT_TYPE
    ushort UsagePage,   // WORD
    ushort LinkCollection,   // WORD optional
    ushort Usage,   // WORD
    HIDP_BUTTON_ARRAY_DATA* ButtonData,   // HIDP_BUTTON_ARRAY_DATA* out
    ushort* ButtonDataLength,   // WORD* in/out
    ptrdiff_t PreparsedData,   // PHIDP_PREPARSED_DATA
    const(char)* Report,   // LPSTR
    uint ReportLength   // DWORD
);

ccall((:HidP_GetButtonArray, "HID.dll"), stdcall, Int32,
      (Int32, UInt16, UInt16, UInt16, Ptr{HIDP_BUTTON_ARRAY_DATA}, Ptr{UInt16}, Int, Cstring, UInt32),
      ReportType, UsagePage, LinkCollection, Usage, ButtonData, ButtonDataLength, PreparsedData, Report, ReportLength)
# ReportType : HIDP_REPORT_TYPE -> Int32
# UsagePage : WORD -> UInt16
# LinkCollection : WORD optional -> UInt16
# Usage : WORD -> UInt16
# ButtonData : HIDP_BUTTON_ARRAY_DATA* out -> Ptr{HIDP_BUTTON_ARRAY_DATA}
# ButtonDataLength : WORD* in/out -> Ptr{UInt16}
# PreparsedData : PHIDP_PREPARSED_DATA -> Int
# Report : LPSTR -> Cstring
# ReportLength : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t HidP_GetButtonArray(
    int32_t ReportType,
    uint16_t UsagePage,
    uint16_t LinkCollection,
    uint16_t Usage,
    void* ButtonData,
    uint16_t* ButtonDataLength,
    intptr_t PreparsedData,
    const char* Report,
    uint32_t ReportLength);
]]
local hid = ffi.load("hid")
-- hid.HidP_GetButtonArray(ReportType, UsagePage, LinkCollection, Usage, ButtonData, ButtonDataLength, PreparsedData, Report, ReportLength)
-- ReportType : HIDP_REPORT_TYPE
-- UsagePage : WORD
-- LinkCollection : WORD optional
-- Usage : WORD
-- ButtonData : HIDP_BUTTON_ARRAY_DATA* out
-- ButtonDataLength : WORD* in/out
-- PreparsedData : PHIDP_PREPARSED_DATA
-- Report : LPSTR
-- ReportLength : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('HID.dll');
const HidP_GetButtonArray = lib.func('__stdcall', 'HidP_GetButtonArray', 'int32_t', ['int32_t', 'uint16_t', 'uint16_t', 'uint16_t', 'void *', 'uint16_t *', 'intptr_t', 'str', 'uint32_t']);
// HidP_GetButtonArray(ReportType, UsagePage, LinkCollection, Usage, ButtonData, ButtonDataLength, PreparsedData, Report, ReportLength)
// ReportType : HIDP_REPORT_TYPE -> 'int32_t'
// UsagePage : WORD -> 'uint16_t'
// LinkCollection : WORD optional -> 'uint16_t'
// Usage : WORD -> 'uint16_t'
// ButtonData : HIDP_BUTTON_ARRAY_DATA* out -> 'void *'
// ButtonDataLength : WORD* in/out -> 'uint16_t *'
// PreparsedData : PHIDP_PREPARSED_DATA -> 'intptr_t'
// Report : LPSTR -> 'str'
// ReportLength : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("HID.dll", {
  HidP_GetButtonArray: { parameters: ["i32", "u16", "u16", "u16", "pointer", "pointer", "isize", "buffer", "u32"], result: "i32" },
});
// lib.symbols.HidP_GetButtonArray(ReportType, UsagePage, LinkCollection, Usage, ButtonData, ButtonDataLength, PreparsedData, Report, ReportLength)
// ReportType : HIDP_REPORT_TYPE -> "i32"
// UsagePage : WORD -> "u16"
// LinkCollection : WORD optional -> "u16"
// Usage : WORD -> "u16"
// ButtonData : HIDP_BUTTON_ARRAY_DATA* out -> "pointer"
// ButtonDataLength : WORD* in/out -> "pointer"
// PreparsedData : PHIDP_PREPARSED_DATA -> "isize"
// Report : LPSTR -> "buffer"
// ReportLength : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t HidP_GetButtonArray(
    int32_t ReportType,
    uint16_t UsagePage,
    uint16_t LinkCollection,
    uint16_t Usage,
    void* ButtonData,
    uint16_t* ButtonDataLength,
    intptr_t PreparsedData,
    const char* Report,
    uint32_t ReportLength);
C, "HID.dll");
// $ffi->HidP_GetButtonArray(ReportType, UsagePage, LinkCollection, Usage, ButtonData, ButtonDataLength, PreparsedData, Report, ReportLength);
// ReportType : HIDP_REPORT_TYPE
// UsagePage : WORD
// LinkCollection : WORD optional
// Usage : WORD
// ButtonData : HIDP_BUTTON_ARRAY_DATA* out
// ButtonDataLength : WORD* in/out
// PreparsedData : PHIDP_PREPARSED_DATA
// Report : LPSTR
// 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_GetButtonArray(
        int ReportType,   // HIDP_REPORT_TYPE
        short UsagePage,   // WORD
        short LinkCollection,   // WORD optional
        short Usage,   // WORD
        Pointer ButtonData,   // HIDP_BUTTON_ARRAY_DATA* out
        ShortByReference ButtonDataLength,   // WORD* in/out
        long PreparsedData,   // PHIDP_PREPARSED_DATA
        String Report,   // LPSTR
        int ReportLength   // DWORD
    );
}

@[Link("hid")]
lib LibHID
  fun HidP_GetButtonArray = HidP_GetButtonArray(
    ReportType : Int32,   # HIDP_REPORT_TYPE
    UsagePage : UInt16,   # WORD
    LinkCollection : UInt16,   # WORD optional
    Usage : UInt16,   # WORD
    ButtonData : HIDP_BUTTON_ARRAY_DATA*,   # HIDP_BUTTON_ARRAY_DATA* out
    ButtonDataLength : UInt16*,   # WORD* in/out
    PreparsedData : LibC::SSizeT,   # PHIDP_PREPARSED_DATA
    Report : UInt8*,   # LPSTR
    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_GetButtonArrayNative = Int32 Function(Int32, Uint16, Uint16, Uint16, Pointer<Void>, Pointer<Uint16>, IntPtr, Pointer<Utf8>, Uint32);
typedef HidP_GetButtonArrayDart = int Function(int, int, int, int, Pointer<Void>, Pointer<Uint16>, int, Pointer<Utf8>, int);
final HidP_GetButtonArray = DynamicLibrary.open('HID.dll')
    .lookupFunction<HidP_GetButtonArrayNative, HidP_GetButtonArrayDart>('HidP_GetButtonArray');
// ReportType : HIDP_REPORT_TYPE -> Int32
// UsagePage : WORD -> Uint16
// LinkCollection : WORD optional -> Uint16
// Usage : WORD -> Uint16
// ButtonData : HIDP_BUTTON_ARRAY_DATA* out -> Pointer<Void>
// ButtonDataLength : WORD* in/out -> Pointer<Uint16>
// PreparsedData : PHIDP_PREPARSED_DATA -> IntPtr
// Report : LPSTR -> Pointer<Utf8>
// ReportLength : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function HidP_GetButtonArray(
  ReportType: Integer;   // HIDP_REPORT_TYPE
  UsagePage: Word;   // WORD
  LinkCollection: Word;   // WORD optional
  Usage: Word;   // WORD
  ButtonData: Pointer;   // HIDP_BUTTON_ARRAY_DATA* out
  ButtonDataLength: Pointer;   // WORD* in/out
  PreparsedData: NativeInt;   // PHIDP_PREPARSED_DATA
  Report: PAnsiChar;   // LPSTR
  ReportLength: DWORD   // DWORD
): Integer; stdcall;
  external 'HID.dll' name 'HidP_GetButtonArray';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HidP_GetButtonArray"
  c_HidP_GetButtonArray :: Int32 -> Word16 -> Word16 -> Word16 -> Ptr () -> Ptr Word16 -> CIntPtr -> CString -> Word32 -> IO Int32
-- ReportType : HIDP_REPORT_TYPE -> Int32
-- UsagePage : WORD -> Word16
-- LinkCollection : WORD optional -> Word16
-- Usage : WORD -> Word16
-- ButtonData : HIDP_BUTTON_ARRAY_DATA* out -> Ptr ()
-- ButtonDataLength : WORD* in/out -> Ptr Word16
-- PreparsedData : PHIDP_PREPARSED_DATA -> CIntPtr
-- Report : LPSTR -> CString
-- ReportLength : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let hidp_getbuttonarray =
  foreign "HidP_GetButtonArray"
    (int32_t @-> uint16_t @-> uint16_t @-> uint16_t @-> (ptr void) @-> (ptr uint16_t) @-> intptr_t @-> string @-> uint32_t @-> returning int32_t)
(* ReportType : HIDP_REPORT_TYPE -> int32_t *)
(* UsagePage : WORD -> uint16_t *)
(* LinkCollection : WORD optional -> uint16_t *)
(* Usage : WORD -> uint16_t *)
(* ButtonData : HIDP_BUTTON_ARRAY_DATA* out -> (ptr void) *)
(* ButtonDataLength : WORD* in/out -> (ptr uint16_t) *)
(* PreparsedData : PHIDP_PREPARSED_DATA -> intptr_t *)
(* Report : LPSTR -> 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_GetButtonArray" hid-p-get-button-array :convention :stdcall) :int32
  (report-type :int32)   ; HIDP_REPORT_TYPE
  (usage-page :uint16)   ; WORD
  (link-collection :uint16)   ; WORD optional
  (usage :uint16)   ; WORD
  (button-data :pointer)   ; HIDP_BUTTON_ARRAY_DATA* out
  (button-data-length :pointer)   ; WORD* in/out
  (preparsed-data :int64)   ; PHIDP_PREPARSED_DATA
  (report :string)   ; LPSTR
  (report-length :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $HidP_GetButtonArray = Win32::API::More->new('HID',
    'int HidP_GetButtonArray(int ReportType, WORD UsagePage, WORD LinkCollection, WORD Usage, LPVOID ButtonData, LPVOID ButtonDataLength, LPARAM PreparsedData, LPCSTR Report, DWORD ReportLength)');
# my $ret = $HidP_GetButtonArray->Call($ReportType, $UsagePage, $LinkCollection, $Usage, $ButtonData, $ButtonDataLength, $PreparsedData, $Report, $ReportLength);
# ReportType : HIDP_REPORT_TYPE -> int
# UsagePage : WORD -> WORD
# LinkCollection : WORD optional -> WORD
# Usage : WORD -> WORD
# ButtonData : HIDP_BUTTON_ARRAY_DATA* out -> LPVOID
# ButtonDataLength : WORD* in/out -> LPVOID
# PreparsedData : PHIDP_PREPARSED_DATA -> LPARAM
# Report : LPSTR -> LPCSTR
# ReportLength : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

HidP_GetButtonArray

シグネチャ

パラメーター

各言語での呼び出し定義

関連項目