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

HidP_GetExtendedAttributes

関数
指定したHID値コントロールの拡張属性を取得する。
DLLHID.dll呼出規約winapi

シグネチャ

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

NTSTATUS HidP_GetExtendedAttributes(
    HIDP_REPORT_TYPE ReportType,
    WORD DataIndex,
    PHIDP_PREPARSED_DATA PreparsedData,
    HIDP_EXTENDED_ATTRIBUTES* Attributes,
    DWORD* LengthAttributes
);

パラメーター

名前方向説明
ReportTypeHIDP_REPORT_TYPEin対象のレポート種別をHIDP_REPORT_TYPE(Input/Output/Feature)で指定する。
DataIndexWORDin拡張属性を取得する対象のデータインデックスを指定する。
PreparsedDataPHIDP_PREPARSED_DATAinHidD_GetPreparsedDataで取得した前解析データへのポインタを指定する。
AttributesHIDP_EXTENDED_ATTRIBUTES*out拡張属性情報(HIDP_EXTENDED_ATTRIBUTES)を受け取るバッファへのポインタを指定する。
LengthAttributesDWORD*inout入出力でバッファのバイトサイズを指定し、必要/使用サイズを受け取るDWORDへのポインタ。

戻り値の型: NTSTATUS

各言語での呼び出し定義

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

NTSTATUS HidP_GetExtendedAttributes(
    HIDP_REPORT_TYPE ReportType,
    WORD DataIndex,
    PHIDP_PREPARSED_DATA PreparsedData,
    HIDP_EXTENDED_ATTRIBUTES* Attributes,
    DWORD* LengthAttributes
);
[DllImport("HID.dll", ExactSpelling = true)]
static extern int HidP_GetExtendedAttributes(
    int ReportType,   // HIDP_REPORT_TYPE
    ushort DataIndex,   // WORD
    IntPtr PreparsedData,   // PHIDP_PREPARSED_DATA
    IntPtr Attributes,   // HIDP_EXTENDED_ATTRIBUTES* out
    ref uint LengthAttributes   // DWORD* in/out
);
<DllImport("HID.dll", ExactSpelling:=True)>
Public Shared Function HidP_GetExtendedAttributes(
    ReportType As Integer,   ' HIDP_REPORT_TYPE
    DataIndex As UShort,   ' WORD
    PreparsedData As IntPtr,   ' PHIDP_PREPARSED_DATA
    Attributes As IntPtr,   ' HIDP_EXTENDED_ATTRIBUTES* out
    ByRef LengthAttributes As UInteger   ' DWORD* in/out
) As Integer
End Function
' ReportType : HIDP_REPORT_TYPE
' DataIndex : WORD
' PreparsedData : PHIDP_PREPARSED_DATA
' Attributes : HIDP_EXTENDED_ATTRIBUTES* out
' LengthAttributes : DWORD* in/out
Declare PtrSafe Function HidP_GetExtendedAttributes Lib "hid" ( _
    ByVal ReportType As Long, _
    ByVal DataIndex As Integer, _
    ByVal PreparsedData As LongPtr, _
    ByVal Attributes As LongPtr, _
    ByRef LengthAttributes As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HidP_GetExtendedAttributes = ctypes.windll.hid.HidP_GetExtendedAttributes
HidP_GetExtendedAttributes.restype = ctypes.c_int
HidP_GetExtendedAttributes.argtypes = [
    ctypes.c_int,  # ReportType : HIDP_REPORT_TYPE
    ctypes.c_ushort,  # DataIndex : WORD
    ctypes.c_ssize_t,  # PreparsedData : PHIDP_PREPARSED_DATA
    ctypes.c_void_p,  # Attributes : HIDP_EXTENDED_ATTRIBUTES* out
    ctypes.POINTER(wintypes.DWORD),  # LengthAttributes : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	hid = windows.NewLazySystemDLL("HID.dll")
	procHidP_GetExtendedAttributes = hid.NewProc("HidP_GetExtendedAttributes")
)

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

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

typedef HidP_GetExtendedAttributesNative = Int32 Function(Int32, Uint16, IntPtr, Pointer<Void>, Pointer<Uint32>);
typedef HidP_GetExtendedAttributesDart = int Function(int, int, int, Pointer<Void>, Pointer<Uint32>);
final HidP_GetExtendedAttributes = DynamicLibrary.open('HID.dll')
    .lookupFunction<HidP_GetExtendedAttributesNative, HidP_GetExtendedAttributesDart>('HidP_GetExtendedAttributes');
// ReportType : HIDP_REPORT_TYPE -> Int32
// DataIndex : WORD -> Uint16
// PreparsedData : PHIDP_PREPARSED_DATA -> IntPtr
// Attributes : HIDP_EXTENDED_ATTRIBUTES* out -> Pointer<Void>
// LengthAttributes : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HidP_GetExtendedAttributes(
  ReportType: Integer;   // HIDP_REPORT_TYPE
  DataIndex: Word;   // WORD
  PreparsedData: NativeInt;   // PHIDP_PREPARSED_DATA
  Attributes: Pointer;   // HIDP_EXTENDED_ATTRIBUTES* out
  LengthAttributes: Pointer   // DWORD* in/out
): Integer; stdcall;
  external 'HID.dll' name 'HidP_GetExtendedAttributes';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HidP_GetExtendedAttributes"
  c_HidP_GetExtendedAttributes :: Int32 -> Word16 -> CIntPtr -> Ptr () -> Ptr Word32 -> IO Int32
-- ReportType : HIDP_REPORT_TYPE -> Int32
-- DataIndex : WORD -> Word16
-- PreparsedData : PHIDP_PREPARSED_DATA -> CIntPtr
-- Attributes : HIDP_EXTENDED_ATTRIBUTES* out -> Ptr ()
-- LengthAttributes : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let hidp_getextendedattributes =
  foreign "HidP_GetExtendedAttributes"
    (int32_t @-> uint16_t @-> intptr_t @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* ReportType : HIDP_REPORT_TYPE -> int32_t *)
(* DataIndex : WORD -> uint16_t *)
(* PreparsedData : PHIDP_PREPARSED_DATA -> intptr_t *)
(* Attributes : HIDP_EXTENDED_ATTRIBUTES* out -> (ptr void) *)
(* LengthAttributes : DWORD* in/out -> (ptr 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_GetExtendedAttributes" hid-p-get-extended-attributes :convention :stdcall) :int32
  (report-type :int32)   ; HIDP_REPORT_TYPE
  (data-index :uint16)   ; WORD
  (preparsed-data :int64)   ; PHIDP_PREPARSED_DATA
  (attributes :pointer)   ; HIDP_EXTENDED_ATTRIBUTES* out
  (length-attributes :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HidP_GetExtendedAttributes = Win32::API::More->new('HID',
    'int HidP_GetExtendedAttributes(int ReportType, WORD DataIndex, LPARAM PreparsedData, LPVOID Attributes, LPVOID LengthAttributes)');
# my $ret = $HidP_GetExtendedAttributes->Call($ReportType, $DataIndex, $PreparsedData, $Attributes, $LengthAttributes);
# ReportType : HIDP_REPORT_TYPE -> int
# DataIndex : WORD -> WORD
# PreparsedData : PHIDP_PREPARSED_DATA -> LPARAM
# Attributes : HIDP_EXTENDED_ATTRIBUTES* out -> LPVOID
# LengthAttributes : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型