ホーム › Devices.Usb › WinUsb_GetDescriptor

WinUsb_GetDescriptor

関数

USBデバイスから指定した種類のディスクリプタを取得する。

DLLWINUSB.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL WinUsb_GetDescriptor(
    WINUSB_INTERFACE_HANDLE InterfaceHandle,
    BYTE DescriptorType,
    BYTE Index,
    WORD LanguageID,
    BYTE* Buffer,   // optional
    DWORD BufferLength,
    DWORD* LengthTransferred
);

パラメーター

名前	型	方向
InterfaceHandle	WINUSB_INTERFACE_HANDLE	in
DescriptorType	BYTE	in
Index	BYTE	in
LanguageID	WORD	in
Buffer	BYTE*	outoptional
BufferLength	DWORD	in
LengthTransferred	DWORD*	out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL WinUsb_GetDescriptor(
    WINUSB_INTERFACE_HANDLE InterfaceHandle,
    BYTE DescriptorType,
    BYTE Index,
    WORD LanguageID,
    BYTE* Buffer,   // optional
    DWORD BufferLength,
    DWORD* LengthTransferred
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINUSB.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinUsb_GetDescriptor(
    IntPtr InterfaceHandle,   // WINUSB_INTERFACE_HANDLE
    byte DescriptorType,   // BYTE
    byte Index,   // BYTE
    ushort LanguageID,   // WORD
    IntPtr Buffer,   // BYTE* optional, out
    uint BufferLength,   // DWORD
    out uint LengthTransferred   // DWORD* out
);

<DllImport("WINUSB.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinUsb_GetDescriptor(
    InterfaceHandle As IntPtr,   ' WINUSB_INTERFACE_HANDLE
    DescriptorType As Byte,   ' BYTE
    Index As Byte,   ' BYTE
    LanguageID As UShort,   ' WORD
    Buffer As IntPtr,   ' BYTE* optional, out
    BufferLength As UInteger,   ' DWORD
    <Out> ByRef LengthTransferred As UInteger   ' DWORD* out
) As Boolean
End Function

' InterfaceHandle : WINUSB_INTERFACE_HANDLE
' DescriptorType : BYTE
' Index : BYTE
' LanguageID : WORD
' Buffer : BYTE* optional, out
' BufferLength : DWORD
' LengthTransferred : DWORD* out
Declare PtrSafe Function WinUsb_GetDescriptor Lib "winusb" ( _
    ByVal InterfaceHandle As LongPtr, _
    ByVal DescriptorType As Byte, _
    ByVal Index As Byte, _
    ByVal LanguageID As Integer, _
    ByVal Buffer As LongPtr, _
    ByVal BufferLength As Long, _
    ByRef LengthTransferred As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WinUsb_GetDescriptor = ctypes.windll.winusb.WinUsb_GetDescriptor
WinUsb_GetDescriptor.restype = wintypes.BOOL
WinUsb_GetDescriptor.argtypes = [
    wintypes.HANDLE,  # InterfaceHandle : WINUSB_INTERFACE_HANDLE
    ctypes.c_ubyte,  # DescriptorType : BYTE
    ctypes.c_ubyte,  # Index : BYTE
    ctypes.c_ushort,  # LanguageID : WORD
    ctypes.POINTER(ctypes.c_ubyte),  # Buffer : BYTE* optional, out
    wintypes.DWORD,  # BufferLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # LengthTransferred : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINUSB.dll')
WinUsb_GetDescriptor = Fiddle::Function.new(
  lib['WinUsb_GetDescriptor'],
  [
    Fiddle::TYPE_VOIDP,  # InterfaceHandle : WINUSB_INTERFACE_HANDLE
    -Fiddle::TYPE_CHAR,  # DescriptorType : BYTE
    -Fiddle::TYPE_CHAR,  # Index : BYTE
    -Fiddle::TYPE_SHORT,  # LanguageID : WORD
    Fiddle::TYPE_VOIDP,  # Buffer : BYTE* optional, out
    -Fiddle::TYPE_INT,  # BufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # LengthTransferred : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winusb")]
extern "system" {
    fn WinUsb_GetDescriptor(
        InterfaceHandle: *mut core::ffi::c_void,  // WINUSB_INTERFACE_HANDLE
        DescriptorType: u8,  // BYTE
        Index: u8,  // BYTE
        LanguageID: u16,  // WORD
        Buffer: *mut u8,  // BYTE* optional, out
        BufferLength: u32,  // DWORD
        LengthTransferred: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINUSB.dll", SetLastError = true)]
public static extern bool WinUsb_GetDescriptor(IntPtr InterfaceHandle, byte DescriptorType, byte Index, ushort LanguageID, IntPtr Buffer, uint BufferLength, out uint LengthTransferred);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINUSB_WinUsb_GetDescriptor' -Namespace Win32 -PassThru
# $api::WinUsb_GetDescriptor(InterfaceHandle, DescriptorType, Index, LanguageID, Buffer, BufferLength, LengthTransferred)

#uselib "WINUSB.dll"
#func global WinUsb_GetDescriptor "WinUsb_GetDescriptor" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WinUsb_GetDescriptor InterfaceHandle, DescriptorType, Index, LanguageID, varptr(Buffer), BufferLength, varptr(LengthTransferred)   ; 戻り値は stat
; InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "sptr"
; DescriptorType : BYTE -> "sptr"
; Index : BYTE -> "sptr"
; LanguageID : WORD -> "sptr"
; Buffer : BYTE* optional, out -> "sptr"
; BufferLength : DWORD -> "sptr"
; LengthTransferred : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINUSB.dll"
#cfunc global WinUsb_GetDescriptor "WinUsb_GetDescriptor" sptr, int, int, int, var, int, var
; res = WinUsb_GetDescriptor(InterfaceHandle, DescriptorType, Index, LanguageID, Buffer, BufferLength, LengthTransferred)
; InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "sptr"
; DescriptorType : BYTE -> "int"
; Index : BYTE -> "int"
; LanguageID : WORD -> "int"
; Buffer : BYTE* optional, out -> "var"
; BufferLength : DWORD -> "int"
; LengthTransferred : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINUSB.dll"
#cfunc global WinUsb_GetDescriptor "WinUsb_GetDescriptor" sptr, int, int, int, sptr, int, sptr
; res = WinUsb_GetDescriptor(InterfaceHandle, DescriptorType, Index, LanguageID, varptr(Buffer), BufferLength, varptr(LengthTransferred))
; InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "sptr"
; DescriptorType : BYTE -> "int"
; Index : BYTE -> "int"
; LanguageID : WORD -> "int"
; Buffer : BYTE* optional, out -> "sptr"
; BufferLength : DWORD -> "int"
; LengthTransferred : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL WinUsb_GetDescriptor(WINUSB_INTERFACE_HANDLE InterfaceHandle, BYTE DescriptorType, BYTE Index, WORD LanguageID, BYTE* Buffer, DWORD BufferLength, DWORD* LengthTransferred)
#uselib "WINUSB.dll"
#cfunc global WinUsb_GetDescriptor "WinUsb_GetDescriptor" intptr, int, int, int, var, int, var
; res = WinUsb_GetDescriptor(InterfaceHandle, DescriptorType, Index, LanguageID, Buffer, BufferLength, LengthTransferred)
; InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "intptr"
; DescriptorType : BYTE -> "int"
; Index : BYTE -> "int"
; LanguageID : WORD -> "int"
; Buffer : BYTE* optional, out -> "var"
; BufferLength : DWORD -> "int"
; LengthTransferred : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL WinUsb_GetDescriptor(WINUSB_INTERFACE_HANDLE InterfaceHandle, BYTE DescriptorType, BYTE Index, WORD LanguageID, BYTE* Buffer, DWORD BufferLength, DWORD* LengthTransferred)
#uselib "WINUSB.dll"
#cfunc global WinUsb_GetDescriptor "WinUsb_GetDescriptor" intptr, int, int, int, intptr, int, intptr
; res = WinUsb_GetDescriptor(InterfaceHandle, DescriptorType, Index, LanguageID, varptr(Buffer), BufferLength, varptr(LengthTransferred))
; InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "intptr"
; DescriptorType : BYTE -> "int"
; Index : BYTE -> "int"
; LanguageID : WORD -> "int"
; Buffer : BYTE* optional, out -> "intptr"
; BufferLength : DWORD -> "int"
; LengthTransferred : DWORD* out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

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

var (
	winusb = windows.NewLazySystemDLL("WINUSB.dll")
	procWinUsb_GetDescriptor = winusb.NewProc("WinUsb_GetDescriptor")
)

// InterfaceHandle (WINUSB_INTERFACE_HANDLE), DescriptorType (BYTE), Index (BYTE), LanguageID (WORD), Buffer (BYTE* optional, out), BufferLength (DWORD), LengthTransferred (DWORD* out)
r1, _, err := procWinUsb_GetDescriptor.Call(
	uintptr(InterfaceHandle),
	uintptr(DescriptorType),
	uintptr(Index),
	uintptr(LanguageID),
	uintptr(Buffer),
	uintptr(BufferLength),
	uintptr(LengthTransferred),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function WinUsb_GetDescriptor(
  InterfaceHandle: THandle;   // WINUSB_INTERFACE_HANDLE
  DescriptorType: Byte;   // BYTE
  Index: Byte;   // BYTE
  LanguageID: Word;   // WORD
  Buffer: Pointer;   // BYTE* optional, out
  BufferLength: DWORD;   // DWORD
  LengthTransferred: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WINUSB.dll' name 'WinUsb_GetDescriptor';

result := DllCall("WINUSB\WinUsb_GetDescriptor"
    , "Ptr", InterfaceHandle   ; WINUSB_INTERFACE_HANDLE
    , "UChar", DescriptorType   ; BYTE
    , "UChar", Index   ; BYTE
    , "UShort", LanguageID   ; WORD
    , "Ptr", Buffer   ; BYTE* optional, out
    , "UInt", BufferLength   ; DWORD
    , "Ptr", LengthTransferred   ; DWORD* out
    , "Int")   ; return: BOOL

●WinUsb_GetDescriptor(InterfaceHandle, DescriptorType, Index, LanguageID, Buffer, BufferLength, LengthTransferred) = DLL("WINUSB.dll", "bool WinUsb_GetDescriptor(void*, byte, byte, int, void*, dword, void*)")
# 呼び出し: WinUsb_GetDescriptor(InterfaceHandle, DescriptorType, Index, LanguageID, Buffer, BufferLength, LengthTransferred)
# InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "void*"
# DescriptorType : BYTE -> "byte"
# Index : BYTE -> "byte"
# LanguageID : WORD -> "int"
# Buffer : BYTE* optional, out -> "void*"
# BufferLength : DWORD -> "dword"
# LengthTransferred : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。