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

WinUsb_ReadPipe

関数
指定したパイプからデータを読み取る。
DLLWINUSB.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL WinUsb_ReadPipe(
    WINUSB_INTERFACE_HANDLE InterfaceHandle,
    BYTE PipeID,
    BYTE* Buffer,   // optional
    DWORD BufferLength,
    DWORD* LengthTransferred,   // optional
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前方向説明
InterfaceHandleWINUSB_INTERFACE_HANDLEin読み取りを行う対象のWinUSBインターフェイスハンドル。
PipeIDBYTEin読み取り元パイプのエンドポイントアドレス。IN方向を指定する。
BufferBYTE*outoptional読み取ったデータを格納するバッファへのポインタ。
BufferLengthDWORDin読み取る最大バイト数(Bufferのサイズ)。
LengthTransferredDWORD*outoptional実際に読み取ったバイト数を受け取る出力先ポインタ。非同期時はNULL可。
OverlappedOVERLAPPED*inoptional非同期I/O用のOVERLAPPED構造体へのポインタ。同期時はNULL。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL WinUsb_ReadPipe(
    WINUSB_INTERFACE_HANDLE InterfaceHandle,
    BYTE PipeID,
    BYTE* Buffer,   // optional
    DWORD BufferLength,
    DWORD* LengthTransferred,   // optional
    OVERLAPPED* Overlapped   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINUSB.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinUsb_ReadPipe(
    IntPtr InterfaceHandle,   // WINUSB_INTERFACE_HANDLE
    byte PipeID,   // BYTE
    IntPtr Buffer,   // BYTE* optional, out
    uint BufferLength,   // DWORD
    IntPtr LengthTransferred,   // DWORD* optional, out
    IntPtr Overlapped   // OVERLAPPED* optional
);
<DllImport("WINUSB.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinUsb_ReadPipe(
    InterfaceHandle As IntPtr,   ' WINUSB_INTERFACE_HANDLE
    PipeID As Byte,   ' BYTE
    Buffer As IntPtr,   ' BYTE* optional, out
    BufferLength As UInteger,   ' DWORD
    LengthTransferred As IntPtr,   ' DWORD* optional, out
    Overlapped As IntPtr   ' OVERLAPPED* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' InterfaceHandle : WINUSB_INTERFACE_HANDLE
' PipeID : BYTE
' Buffer : BYTE* optional, out
' BufferLength : DWORD
' LengthTransferred : DWORD* optional, out
' Overlapped : OVERLAPPED* optional
Declare PtrSafe Function WinUsb_ReadPipe Lib "winusb" ( _
    ByVal InterfaceHandle As LongPtr, _
    ByVal PipeID As Byte, _
    ByVal Buffer As LongPtr, _
    ByVal BufferLength As Long, _
    ByVal LengthTransferred As LongPtr, _
    ByVal Overlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WinUsb_ReadPipe = ctypes.windll.winusb.WinUsb_ReadPipe
WinUsb_ReadPipe.restype = wintypes.BOOL
WinUsb_ReadPipe.argtypes = [
    wintypes.HANDLE,  # InterfaceHandle : WINUSB_INTERFACE_HANDLE
    ctypes.c_ubyte,  # PipeID : BYTE
    ctypes.POINTER(ctypes.c_ubyte),  # Buffer : BYTE* optional, out
    wintypes.DWORD,  # BufferLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # LengthTransferred : DWORD* optional, out
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINUSB.dll')
WinUsb_ReadPipe = Fiddle::Function.new(
  lib['WinUsb_ReadPipe'],
  [
    Fiddle::TYPE_VOIDP,  # InterfaceHandle : WINUSB_INTERFACE_HANDLE
    -Fiddle::TYPE_CHAR,  # PipeID : BYTE
    Fiddle::TYPE_VOIDP,  # Buffer : BYTE* optional, out
    -Fiddle::TYPE_INT,  # BufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # LengthTransferred : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "winusb")]
extern "system" {
    fn WinUsb_ReadPipe(
        InterfaceHandle: *mut core::ffi::c_void,  // WINUSB_INTERFACE_HANDLE
        PipeID: u8,  // BYTE
        Buffer: *mut u8,  // BYTE* optional, out
        BufferLength: u32,  // DWORD
        LengthTransferred: *mut u32,  // DWORD* optional, out
        Overlapped: *mut OVERLAPPED  // OVERLAPPED* optional
    ) -> 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_ReadPipe(IntPtr InterfaceHandle, byte PipeID, IntPtr Buffer, uint BufferLength, IntPtr LengthTransferred, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINUSB_WinUsb_ReadPipe' -Namespace Win32 -PassThru
# $api::WinUsb_ReadPipe(InterfaceHandle, PipeID, Buffer, BufferLength, LengthTransferred, Overlapped)
#uselib "WINUSB.dll"
#func global WinUsb_ReadPipe "WinUsb_ReadPipe" sptr, sptr, sptr, sptr, sptr, sptr
; WinUsb_ReadPipe InterfaceHandle, PipeID, varptr(Buffer), BufferLength, varptr(LengthTransferred), varptr(Overlapped)   ; 戻り値は stat
; InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "sptr"
; PipeID : BYTE -> "sptr"
; Buffer : BYTE* optional, out -> "sptr"
; BufferLength : DWORD -> "sptr"
; LengthTransferred : DWORD* optional, out -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINUSB.dll"
#cfunc global WinUsb_ReadPipe "WinUsb_ReadPipe" sptr, int, var, int, var, var
; res = WinUsb_ReadPipe(InterfaceHandle, PipeID, Buffer, BufferLength, LengthTransferred, Overlapped)
; InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "sptr"
; PipeID : BYTE -> "int"
; Buffer : BYTE* optional, out -> "var"
; BufferLength : DWORD -> "int"
; LengthTransferred : DWORD* optional, out -> "var"
; Overlapped : OVERLAPPED* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL WinUsb_ReadPipe(WINUSB_INTERFACE_HANDLE InterfaceHandle, BYTE PipeID, BYTE* Buffer, DWORD BufferLength, DWORD* LengthTransferred, OVERLAPPED* Overlapped)
#uselib "WINUSB.dll"
#cfunc global WinUsb_ReadPipe "WinUsb_ReadPipe" intptr, int, var, int, var, var
; res = WinUsb_ReadPipe(InterfaceHandle, PipeID, Buffer, BufferLength, LengthTransferred, Overlapped)
; InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "intptr"
; PipeID : BYTE -> "int"
; Buffer : BYTE* optional, out -> "var"
; BufferLength : DWORD -> "int"
; LengthTransferred : DWORD* optional, out -> "var"
; Overlapped : OVERLAPPED* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winusb = windows.NewLazySystemDLL("WINUSB.dll")
	procWinUsb_ReadPipe = winusb.NewProc("WinUsb_ReadPipe")
)

// InterfaceHandle (WINUSB_INTERFACE_HANDLE), PipeID (BYTE), Buffer (BYTE* optional, out), BufferLength (DWORD), LengthTransferred (DWORD* optional, out), Overlapped (OVERLAPPED* optional)
r1, _, err := procWinUsb_ReadPipe.Call(
	uintptr(InterfaceHandle),
	uintptr(PipeID),
	uintptr(Buffer),
	uintptr(BufferLength),
	uintptr(LengthTransferred),
	uintptr(Overlapped),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WinUsb_ReadPipe(
  InterfaceHandle: THandle;   // WINUSB_INTERFACE_HANDLE
  PipeID: Byte;   // BYTE
  Buffer: Pointer;   // BYTE* optional, out
  BufferLength: DWORD;   // DWORD
  LengthTransferred: Pointer;   // DWORD* optional, out
  Overlapped: Pointer   // OVERLAPPED* optional
): BOOL; stdcall;
  external 'WINUSB.dll' name 'WinUsb_ReadPipe';
result := DllCall("WINUSB\WinUsb_ReadPipe"
    , "Ptr", InterfaceHandle   ; WINUSB_INTERFACE_HANDLE
    , "UChar", PipeID   ; BYTE
    , "Ptr", Buffer   ; BYTE* optional, out
    , "UInt", BufferLength   ; DWORD
    , "Ptr", LengthTransferred   ; DWORD* optional, out
    , "Ptr", Overlapped   ; OVERLAPPED* optional
    , "Int")   ; return: BOOL
●WinUsb_ReadPipe(InterfaceHandle, PipeID, Buffer, BufferLength, LengthTransferred, Overlapped) = DLL("WINUSB.dll", "bool WinUsb_ReadPipe(void*, byte, void*, dword, void*, void*)")
# 呼び出し: WinUsb_ReadPipe(InterfaceHandle, PipeID, Buffer, BufferLength, LengthTransferred, Overlapped)
# InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "void*"
# PipeID : BYTE -> "byte"
# Buffer : BYTE* optional, out -> "void*"
# BufferLength : DWORD -> "dword"
# LengthTransferred : DWORD* optional, out -> "void*"
# Overlapped : OVERLAPPED* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef WinUsb_ReadPipeNative = Int32 Function(Pointer<Void>, Uint8, Pointer<Uint8>, Uint32, Pointer<Uint32>, Pointer<Void>);
typedef WinUsb_ReadPipeDart = int Function(Pointer<Void>, int, Pointer<Uint8>, int, Pointer<Uint32>, Pointer<Void>);
final WinUsb_ReadPipe = DynamicLibrary.open('WINUSB.dll')
    .lookupFunction<WinUsb_ReadPipeNative, WinUsb_ReadPipeDart>('WinUsb_ReadPipe');
// InterfaceHandle : WINUSB_INTERFACE_HANDLE -> Pointer<Void>
// PipeID : BYTE -> Uint8
// Buffer : BYTE* optional, out -> Pointer<Uint8>
// BufferLength : DWORD -> Uint32
// LengthTransferred : DWORD* optional, out -> Pointer<Uint32>
// Overlapped : OVERLAPPED* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinUsb_ReadPipe(
  InterfaceHandle: THandle;   // WINUSB_INTERFACE_HANDLE
  PipeID: Byte;   // BYTE
  Buffer: Pointer;   // BYTE* optional, out
  BufferLength: DWORD;   // DWORD
  LengthTransferred: Pointer;   // DWORD* optional, out
  Overlapped: Pointer   // OVERLAPPED* optional
): BOOL; stdcall;
  external 'WINUSB.dll' name 'WinUsb_ReadPipe';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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

関連項目

使用する型