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

HidD_GetPreparsedData

関数
HIDデバイスの解析済みレポート記述子データを取得する。
DLLHID.dll呼出規約winapi

シグネチャ

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

BOOLEAN HidD_GetPreparsedData(
    HANDLE HidDeviceObject,
    PHIDP_PREPARSED_DATA* PreparsedData
);

パラメーター

名前方向説明
HidDeviceObjectHANDLEin対象のHIDデバイスを開いたファイルハンドルを指定する。
PreparsedDataPHIDP_PREPARSED_DATA*out前解析データのハンドルを受け取るポインタを指定する。HidD_FreePreparsedDataで解放する。

戻り値の型: BOOLEAN

各言語での呼び出し定義

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

BOOLEAN HidD_GetPreparsedData(
    HANDLE HidDeviceObject,
    PHIDP_PREPARSED_DATA* PreparsedData
);
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("HID.dll", ExactSpelling = true)]
static extern bool HidD_GetPreparsedData(
    IntPtr HidDeviceObject,   // HANDLE
    out IntPtr PreparsedData   // PHIDP_PREPARSED_DATA* out
);
<DllImport("HID.dll", ExactSpelling:=True)>
Public Shared Function HidD_GetPreparsedData(
    HidDeviceObject As IntPtr,   ' HANDLE
    <Out> ByRef PreparsedData As IntPtr   ' PHIDP_PREPARSED_DATA* out
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function
' HidDeviceObject : HANDLE
' PreparsedData : PHIDP_PREPARSED_DATA* out
Declare PtrSafe Function HidD_GetPreparsedData Lib "hid" ( _
    ByVal HidDeviceObject As LongPtr, _
    ByRef PreparsedData As LongPtr) As Byte
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HidD_GetPreparsedData = ctypes.windll.hid.HidD_GetPreparsedData
HidD_GetPreparsedData.restype = wintypes.BOOLEAN
HidD_GetPreparsedData.argtypes = [
    wintypes.HANDLE,  # HidDeviceObject : HANDLE
    ctypes.c_void_p,  # PreparsedData : PHIDP_PREPARSED_DATA* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HID.dll')
HidD_GetPreparsedData = Fiddle::Function.new(
  lib['HidD_GetPreparsedData'],
  [
    Fiddle::TYPE_VOIDP,  # HidDeviceObject : HANDLE
    Fiddle::TYPE_VOIDP,  # PreparsedData : PHIDP_PREPARSED_DATA* out
  ],
  Fiddle::TYPE_CHAR)
#[link(name = "hid")]
extern "system" {
    fn HidD_GetPreparsedData(
        HidDeviceObject: *mut core::ffi::c_void,  // HANDLE
        PreparsedData: *mut isize  // PHIDP_PREPARSED_DATA* out
    ) -> u8;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("HID.dll")]
public static extern bool HidD_GetPreparsedData(IntPtr HidDeviceObject, out IntPtr PreparsedData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HID_HidD_GetPreparsedData' -Namespace Win32 -PassThru
# $api::HidD_GetPreparsedData(HidDeviceObject, PreparsedData)
#uselib "HID.dll"
#func global HidD_GetPreparsedData "HidD_GetPreparsedData" sptr, sptr
; HidD_GetPreparsedData HidDeviceObject, varptr(PreparsedData)   ; 戻り値は stat
; HidDeviceObject : HANDLE -> "sptr"
; PreparsedData : PHIDP_PREPARSED_DATA* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "HID.dll"
#cfunc global HidD_GetPreparsedData "HidD_GetPreparsedData" sptr, var
; res = HidD_GetPreparsedData(HidDeviceObject, PreparsedData)
; HidDeviceObject : HANDLE -> "sptr"
; PreparsedData : PHIDP_PREPARSED_DATA* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOLEAN HidD_GetPreparsedData(HANDLE HidDeviceObject, PHIDP_PREPARSED_DATA* PreparsedData)
#uselib "HID.dll"
#cfunc global HidD_GetPreparsedData "HidD_GetPreparsedData" intptr, var
; res = HidD_GetPreparsedData(HidDeviceObject, PreparsedData)
; HidDeviceObject : HANDLE -> "intptr"
; PreparsedData : PHIDP_PREPARSED_DATA* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	hid = windows.NewLazySystemDLL("HID.dll")
	procHidD_GetPreparsedData = hid.NewProc("HidD_GetPreparsedData")
)

// HidDeviceObject (HANDLE), PreparsedData (PHIDP_PREPARSED_DATA* out)
r1, _, err := procHidD_GetPreparsedData.Call(
	uintptr(HidDeviceObject),
	uintptr(PreparsedData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOLEAN
function HidD_GetPreparsedData(
  HidDeviceObject: THandle;   // HANDLE
  PreparsedData: Pointer   // PHIDP_PREPARSED_DATA* out
): ByteBool; stdcall;
  external 'HID.dll' name 'HidD_GetPreparsedData';
result := DllCall("HID\HidD_GetPreparsedData"
    , "Ptr", HidDeviceObject   ; HANDLE
    , "Ptr", PreparsedData   ; PHIDP_PREPARSED_DATA* out
    , "Char")   ; return: BOOLEAN
●HidD_GetPreparsedData(HidDeviceObject, PreparsedData) = DLL("HID.dll", "byte HidD_GetPreparsedData(void*, void*)")
# 呼び出し: HidD_GetPreparsedData(HidDeviceObject, PreparsedData)
# HidDeviceObject : HANDLE -> "void*"
# PreparsedData : PHIDP_PREPARSED_DATA* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef HidD_GetPreparsedDataNative = Uint8 Function(Pointer<Void>, Pointer<IntPtr>);
typedef HidD_GetPreparsedDataDart = int Function(Pointer<Void>, Pointer<IntPtr>);
final HidD_GetPreparsedData = DynamicLibrary.open('HID.dll')
    .lookupFunction<HidD_GetPreparsedDataNative, HidD_GetPreparsedDataDart>('HidD_GetPreparsedData');
// HidDeviceObject : HANDLE -> Pointer<Void>
// PreparsedData : PHIDP_PREPARSED_DATA* out -> Pointer<IntPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HidD_GetPreparsedData(
  HidDeviceObject: THandle;   // HANDLE
  PreparsedData: Pointer   // PHIDP_PREPARSED_DATA* out
): ByteBool; stdcall;
  external 'HID.dll' name 'HidD_GetPreparsedData';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HidD_GetPreparsedData"
  c_HidD_GetPreparsedData :: Ptr () -> Ptr CIntPtr -> IO Word8
-- HidDeviceObject : HANDLE -> Ptr ()
-- PreparsedData : PHIDP_PREPARSED_DATA* out -> Ptr CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let hidd_getpreparseddata =
  foreign "HidD_GetPreparsedData"
    ((ptr void) @-> (ptr intptr_t) @-> returning uint8_t)
(* HidDeviceObject : HANDLE -> (ptr void) *)
(* PreparsedData : PHIDP_PREPARSED_DATA* out -> (ptr intptr_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library hid (t "HID.dll"))
(cffi:use-foreign-library hid)

(cffi:defcfun ("HidD_GetPreparsedData" hid-d-get-preparsed-data :convention :stdcall) :uint8
  (hid-device-object :pointer)   ; HANDLE
  (preparsed-data :pointer))   ; PHIDP_PREPARSED_DATA* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HidD_GetPreparsedData = Win32::API::More->new('HID',
    'BYTE HidD_GetPreparsedData(HANDLE HidDeviceObject, LPVOID PreparsedData)');
# my $ret = $HidD_GetPreparsedData->Call($HidDeviceObject, $PreparsedData);
# HidDeviceObject : HANDLE -> HANDLE
# PreparsedData : PHIDP_PREPARSED_DATA* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。