Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向説明
InterfaceHandleWINUSB_INTERFACE_HANDLEinディスクリプタを取得する対象のWinUSBインターフェイスハンドル。
DescriptorTypeBYTEin取得するディスクリプタの種類(USB_DEVICE_DESCRIPTOR_TYPE等)。
IndexBYTEinディスクリプタのインデックス。文字列ディスクリプタ等で使用する。
LanguageIDWORDin文字列ディスクリプタ取得時の言語ID。それ以外では0。
BufferBYTE*outoptional取得したディスクリプタを格納するバッファへのポインタ。
BufferLengthDWORDinBufferのバイト数。
LengthTransferredDWORD*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 <MarshalAs(UnmanagedType.Bool)> 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 方式にも切替可。
出力引数:
; 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 方式にも切替可。
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)。
const std = @import("std");

extern "winusb" fn WinUsb_GetDescriptor(
    InterfaceHandle: ?*anyopaque, // WINUSB_INTERFACE_HANDLE
    DescriptorType: u8, // BYTE
    Index: u8, // BYTE
    LanguageID: u16, // WORD
    Buffer: [*c]u8, // BYTE* optional, out
    BufferLength: u32, // DWORD
    LengthTransferred: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
proc WinUsb_GetDescriptor(
    InterfaceHandle: pointer,  # WINUSB_INTERFACE_HANDLE
    DescriptorType: uint8,  # BYTE
    Index: uint8,  # BYTE
    LanguageID: uint16,  # WORD
    Buffer: ptr uint8,  # BYTE* optional, out
    BufferLength: uint32,  # DWORD
    LengthTransferred: ptr uint32  # DWORD* out
): int32 {.importc: "WinUsb_GetDescriptor", stdcall, dynlib: "WINUSB.dll".}
pragma(lib, "winusb");
extern(Windows)
int WinUsb_GetDescriptor(
    void* InterfaceHandle,   // WINUSB_INTERFACE_HANDLE
    ubyte DescriptorType,   // BYTE
    ubyte Index,   // BYTE
    ushort LanguageID,   // WORD
    ubyte* Buffer,   // BYTE* optional, out
    uint BufferLength,   // DWORD
    uint* LengthTransferred   // DWORD* out
);
ccall((:WinUsb_GetDescriptor, "WINUSB.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt8, UInt8, UInt16, Ptr{UInt8}, UInt32, Ptr{UInt32}),
      InterfaceHandle, DescriptorType, Index, LanguageID, Buffer, BufferLength, LengthTransferred)
# InterfaceHandle : WINUSB_INTERFACE_HANDLE -> Ptr{Cvoid}
# DescriptorType : BYTE -> UInt8
# Index : BYTE -> UInt8
# LanguageID : WORD -> UInt16
# Buffer : BYTE* optional, out -> Ptr{UInt8}
# BufferLength : DWORD -> UInt32
# LengthTransferred : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WinUsb_GetDescriptor(
    void* InterfaceHandle,
    uint8_t DescriptorType,
    uint8_t Index,
    uint16_t LanguageID,
    uint8_t* Buffer,
    uint32_t BufferLength,
    uint32_t* LengthTransferred);
]]
local winusb = ffi.load("winusb")
-- winusb.WinUsb_GetDescriptor(InterfaceHandle, DescriptorType, Index, LanguageID, Buffer, BufferLength, LengthTransferred)
-- InterfaceHandle : WINUSB_INTERFACE_HANDLE
-- DescriptorType : BYTE
-- Index : BYTE
-- LanguageID : WORD
-- Buffer : BYTE* optional, out
-- BufferLength : DWORD
-- LengthTransferred : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINUSB.dll');
const WinUsb_GetDescriptor = lib.func('__stdcall', 'WinUsb_GetDescriptor', 'int32_t', ['void *', 'uint8_t', 'uint8_t', 'uint16_t', 'uint8_t *', 'uint32_t', 'uint32_t *']);
// WinUsb_GetDescriptor(InterfaceHandle, DescriptorType, Index, LanguageID, Buffer, BufferLength, LengthTransferred)
// InterfaceHandle : WINUSB_INTERFACE_HANDLE -> 'void *'
// DescriptorType : BYTE -> 'uint8_t'
// Index : BYTE -> 'uint8_t'
// LanguageID : WORD -> 'uint16_t'
// Buffer : BYTE* optional, out -> 'uint8_t *'
// BufferLength : DWORD -> 'uint32_t'
// LengthTransferred : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINUSB.dll", {
  WinUsb_GetDescriptor: { parameters: ["pointer", "u8", "u8", "u16", "pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.WinUsb_GetDescriptor(InterfaceHandle, DescriptorType, Index, LanguageID, Buffer, BufferLength, LengthTransferred)
// InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "pointer"
// DescriptorType : BYTE -> "u8"
// Index : BYTE -> "u8"
// LanguageID : WORD -> "u16"
// Buffer : BYTE* optional, out -> "pointer"
// BufferLength : DWORD -> "u32"
// LengthTransferred : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WinUsb_GetDescriptor(
    void* InterfaceHandle,
    uint8_t DescriptorType,
    uint8_t Index,
    uint16_t LanguageID,
    uint8_t* Buffer,
    uint32_t BufferLength,
    uint32_t* LengthTransferred);
C, "WINUSB.dll");
// $ffi->WinUsb_GetDescriptor(InterfaceHandle, DescriptorType, Index, LanguageID, Buffer, BufferLength, LengthTransferred);
// InterfaceHandle : WINUSB_INTERFACE_HANDLE
// DescriptorType : BYTE
// Index : BYTE
// LanguageID : WORD
// Buffer : BYTE* optional, out
// BufferLength : DWORD
// LengthTransferred : DWORD* 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 Winusb extends StdCallLibrary {
    Winusb INSTANCE = Native.load("winusb", Winusb.class);
    boolean WinUsb_GetDescriptor(
        Pointer InterfaceHandle,   // WINUSB_INTERFACE_HANDLE
        byte DescriptorType,   // BYTE
        byte Index,   // BYTE
        short LanguageID,   // WORD
        byte[] Buffer,   // BYTE* optional, out
        int BufferLength,   // DWORD
        IntByReference LengthTransferred   // DWORD* out
    );
}
@[Link("winusb")]
lib LibWINUSB
  fun WinUsb_GetDescriptor = WinUsb_GetDescriptor(
    InterfaceHandle : Void*,   # WINUSB_INTERFACE_HANDLE
    DescriptorType : UInt8,   # BYTE
    Index : UInt8,   # BYTE
    LanguageID : UInt16,   # WORD
    Buffer : UInt8*,   # BYTE* optional, out
    BufferLength : UInt32,   # DWORD
    LengthTransferred : UInt32*   # DWORD* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WinUsb_GetDescriptorNative = Int32 Function(Pointer<Void>, Uint8, Uint8, Uint16, Pointer<Uint8>, Uint32, Pointer<Uint32>);
typedef WinUsb_GetDescriptorDart = int Function(Pointer<Void>, int, int, int, Pointer<Uint8>, int, Pointer<Uint32>);
final WinUsb_GetDescriptor = DynamicLibrary.open('WINUSB.dll')
    .lookupFunction<WinUsb_GetDescriptorNative, WinUsb_GetDescriptorDart>('WinUsb_GetDescriptor');
// InterfaceHandle : WINUSB_INTERFACE_HANDLE -> Pointer<Void>
// DescriptorType : BYTE -> Uint8
// Index : BYTE -> Uint8
// LanguageID : WORD -> Uint16
// Buffer : BYTE* optional, out -> Pointer<Uint8>
// BufferLength : DWORD -> Uint32
// LengthTransferred : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinUsb_GetDescriptor"
  c_WinUsb_GetDescriptor :: Ptr () -> Word8 -> Word8 -> Word16 -> Ptr Word8 -> Word32 -> Ptr Word32 -> IO CInt
-- InterfaceHandle : WINUSB_INTERFACE_HANDLE -> Ptr ()
-- DescriptorType : BYTE -> Word8
-- Index : BYTE -> Word8
-- LanguageID : WORD -> Word16
-- Buffer : BYTE* optional, out -> Ptr Word8
-- BufferLength : DWORD -> Word32
-- LengthTransferred : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winusb_getdescriptor =
  foreign "WinUsb_GetDescriptor"
    ((ptr void) @-> uint8_t @-> uint8_t @-> uint16_t @-> (ptr uint8_t) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* InterfaceHandle : WINUSB_INTERFACE_HANDLE -> (ptr void) *)
(* DescriptorType : BYTE -> uint8_t *)
(* Index : BYTE -> uint8_t *)
(* LanguageID : WORD -> uint16_t *)
(* Buffer : BYTE* optional, out -> (ptr uint8_t) *)
(* BufferLength : DWORD -> uint32_t *)
(* LengthTransferred : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winusb (t "WINUSB.dll"))
(cffi:use-foreign-library winusb)

(cffi:defcfun ("WinUsb_GetDescriptor" win-usb-get-descriptor :convention :stdcall) :int32
  (interface-handle :pointer)   ; WINUSB_INTERFACE_HANDLE
  (descriptor-type :uint8)   ; BYTE
  (index :uint8)   ; BYTE
  (language-id :uint16)   ; WORD
  (buffer :pointer)   ; BYTE* optional, out
  (buffer-length :uint32)   ; DWORD
  (length-transferred :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinUsb_GetDescriptor = Win32::API::More->new('WINUSB',
    'BOOL WinUsb_GetDescriptor(HANDLE InterfaceHandle, BYTE DescriptorType, BYTE Index, WORD LanguageID, LPVOID Buffer, DWORD BufferLength, LPVOID LengthTransferred)');
# my $ret = $WinUsb_GetDescriptor->Call($InterfaceHandle, $DescriptorType, $Index, $LanguageID, $Buffer, $BufferLength, $LengthTransferred);
# InterfaceHandle : WINUSB_INTERFACE_HANDLE -> HANDLE
# DescriptorType : BYTE -> BYTE
# Index : BYTE -> BYTE
# LanguageID : WORD -> WORD
# Buffer : BYTE* optional, out -> LPVOID
# BufferLength : DWORD -> DWORD
# LengthTransferred : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。