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
PipeIDBYTEin
BufferBYTE*outoptional
BufferLengthDWORDin
LengthTransferredDWORD*outoptional
OverlappedOVERLAPPED*inoptional

戻り値の型: 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 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)。