ホーム › Devices.Usb › WinUsb_ReadIsochPipeAsap

WinUsb_ReadIsochPipeAsap

関数

可能な限り早いフレームからアイソクロナスパイプを読み取る。

DLLWINUSB.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

BOOL WinUsb_ReadIsochPipeAsap(
    void* BufferHandle,
    DWORD Offset,
    DWORD Length,
    BOOL ContinueStream,
    DWORD NumberOfPackets,
    USBD_ISO_PACKET_DESCRIPTOR* IsoPacketDescriptors,
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前	型	方向	説明
BufferHandle	void*	in	登録済みのアイソクロナスバッファハンドル。
Offset	DWORD	in	読み取り開始位置のバッファ先頭からのバイトオフセット。
Length	DWORD	in	読み取るバイト数。
ContinueStream	BOOL	in	直前のストリームを継続するならTRUE、新規開始ならFALSE。
NumberOfPackets	DWORD	in	読み取りに用いるアイソクロナスパケット数。
IsoPacketDescriptors	USBD_ISO_PACKET_DESCRIPTOR*	out	各パケットの結果を受け取るUSBD_ISO_PACKET_DESCRIPTOR配列へのポインタ。
Overlapped	OVERLAPPED*	inoptional	非同期I/O用のOVERLAPPED構造体へのポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL WinUsb_ReadIsochPipeAsap(
    void* BufferHandle,
    DWORD Offset,
    DWORD Length,
    BOOL ContinueStream,
    DWORD NumberOfPackets,
    USBD_ISO_PACKET_DESCRIPTOR* IsoPacketDescriptors,
    OVERLAPPED* Overlapped   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINUSB.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinUsb_ReadIsochPipeAsap(
    IntPtr BufferHandle,   // void*
    uint Offset,   // DWORD
    uint Length,   // DWORD
    bool ContinueStream,   // BOOL
    uint NumberOfPackets,   // DWORD
    IntPtr IsoPacketDescriptors,   // USBD_ISO_PACKET_DESCRIPTOR* out
    IntPtr Overlapped   // OVERLAPPED* optional
);

<DllImport("WINUSB.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinUsb_ReadIsochPipeAsap(
    BufferHandle As IntPtr,   ' void*
    Offset As UInteger,   ' DWORD
    Length As UInteger,   ' DWORD
    ContinueStream As Boolean,   ' BOOL
    NumberOfPackets As UInteger,   ' DWORD
    IsoPacketDescriptors As IntPtr,   ' USBD_ISO_PACKET_DESCRIPTOR* out
    Overlapped As IntPtr   ' OVERLAPPED* optional
) As Boolean
End Function

' BufferHandle : void*
' Offset : DWORD
' Length : DWORD
' ContinueStream : BOOL
' NumberOfPackets : DWORD
' IsoPacketDescriptors : USBD_ISO_PACKET_DESCRIPTOR* out
' Overlapped : OVERLAPPED* optional
Declare PtrSafe Function WinUsb_ReadIsochPipeAsap Lib "winusb" ( _
    ByVal BufferHandle As LongPtr, _
    ByVal Offset As Long, _
    ByVal Length As Long, _
    ByVal ContinueStream As Long, _
    ByVal NumberOfPackets As Long, _
    ByVal IsoPacketDescriptors 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_ReadIsochPipeAsap = ctypes.windll.winusb.WinUsb_ReadIsochPipeAsap
WinUsb_ReadIsochPipeAsap.restype = wintypes.BOOL
WinUsb_ReadIsochPipeAsap.argtypes = [
    ctypes.POINTER(None),  # BufferHandle : void*
    wintypes.DWORD,  # Offset : DWORD
    wintypes.DWORD,  # Length : DWORD
    wintypes.BOOL,  # ContinueStream : BOOL
    wintypes.DWORD,  # NumberOfPackets : DWORD
    ctypes.c_void_p,  # IsoPacketDescriptors : USBD_ISO_PACKET_DESCRIPTOR* 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_ReadIsochPipeAsap = Fiddle::Function.new(
  lib['WinUsb_ReadIsochPipeAsap'],
  [
    Fiddle::TYPE_VOIDP,  # BufferHandle : void*
    -Fiddle::TYPE_INT,  # Offset : DWORD
    -Fiddle::TYPE_INT,  # Length : DWORD
    Fiddle::TYPE_INT,  # ContinueStream : BOOL
    -Fiddle::TYPE_INT,  # NumberOfPackets : DWORD
    Fiddle::TYPE_VOIDP,  # IsoPacketDescriptors : USBD_ISO_PACKET_DESCRIPTOR* out
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "winusb")]
extern "system" {
    fn WinUsb_ReadIsochPipeAsap(
        BufferHandle: *mut (),  // void*
        Offset: u32,  // DWORD
        Length: u32,  // DWORD
        ContinueStream: i32,  // BOOL
        NumberOfPackets: u32,  // DWORD
        IsoPacketDescriptors: *mut USBD_ISO_PACKET_DESCRIPTOR,  // USBD_ISO_PACKET_DESCRIPTOR* 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_ReadIsochPipeAsap(IntPtr BufferHandle, uint Offset, uint Length, bool ContinueStream, uint NumberOfPackets, IntPtr IsoPacketDescriptors, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINUSB_WinUsb_ReadIsochPipeAsap' -Namespace Win32 -PassThru
# $api::WinUsb_ReadIsochPipeAsap(BufferHandle, Offset, Length, ContinueStream, NumberOfPackets, IsoPacketDescriptors, Overlapped)

#uselib "WINUSB.dll"
#func global WinUsb_ReadIsochPipeAsap "WinUsb_ReadIsochPipeAsap" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WinUsb_ReadIsochPipeAsap BufferHandle, Offset, Length, ContinueStream, NumberOfPackets, varptr(IsoPacketDescriptors), varptr(Overlapped)   ; 戻り値は stat
; BufferHandle : void* -> "sptr"
; Offset : DWORD -> "sptr"
; Length : DWORD -> "sptr"
; ContinueStream : BOOL -> "sptr"
; NumberOfPackets : DWORD -> "sptr"
; IsoPacketDescriptors : USBD_ISO_PACKET_DESCRIPTOR* out -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINUSB.dll"
#cfunc global WinUsb_ReadIsochPipeAsap "WinUsb_ReadIsochPipeAsap" sptr, int, int, int, int, var, var
; res = WinUsb_ReadIsochPipeAsap(BufferHandle, Offset, Length, ContinueStream, NumberOfPackets, IsoPacketDescriptors, Overlapped)
; BufferHandle : void* -> "sptr"
; Offset : DWORD -> "int"
; Length : DWORD -> "int"
; ContinueStream : BOOL -> "int"
; NumberOfPackets : DWORD -> "int"
; IsoPacketDescriptors : USBD_ISO_PACKET_DESCRIPTOR* out -> "var"
; Overlapped : OVERLAPPED* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINUSB.dll"
#cfunc global WinUsb_ReadIsochPipeAsap "WinUsb_ReadIsochPipeAsap" sptr, int, int, int, int, sptr, sptr
; res = WinUsb_ReadIsochPipeAsap(BufferHandle, Offset, Length, ContinueStream, NumberOfPackets, varptr(IsoPacketDescriptors), varptr(Overlapped))
; BufferHandle : void* -> "sptr"
; Offset : DWORD -> "int"
; Length : DWORD -> "int"
; ContinueStream : BOOL -> "int"
; NumberOfPackets : DWORD -> "int"
; IsoPacketDescriptors : USBD_ISO_PACKET_DESCRIPTOR* out -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL WinUsb_ReadIsochPipeAsap(void* BufferHandle, DWORD Offset, DWORD Length, BOOL ContinueStream, DWORD NumberOfPackets, USBD_ISO_PACKET_DESCRIPTOR* IsoPacketDescriptors, OVERLAPPED* Overlapped)
#uselib "WINUSB.dll"
#cfunc global WinUsb_ReadIsochPipeAsap "WinUsb_ReadIsochPipeAsap" intptr, int, int, int, int, var, var
; res = WinUsb_ReadIsochPipeAsap(BufferHandle, Offset, Length, ContinueStream, NumberOfPackets, IsoPacketDescriptors, Overlapped)
; BufferHandle : void* -> "intptr"
; Offset : DWORD -> "int"
; Length : DWORD -> "int"
; ContinueStream : BOOL -> "int"
; NumberOfPackets : DWORD -> "int"
; IsoPacketDescriptors : USBD_ISO_PACKET_DESCRIPTOR* out -> "var"
; Overlapped : OVERLAPPED* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL WinUsb_ReadIsochPipeAsap(void* BufferHandle, DWORD Offset, DWORD Length, BOOL ContinueStream, DWORD NumberOfPackets, USBD_ISO_PACKET_DESCRIPTOR* IsoPacketDescriptors, OVERLAPPED* Overlapped)
#uselib "WINUSB.dll"
#cfunc global WinUsb_ReadIsochPipeAsap "WinUsb_ReadIsochPipeAsap" intptr, int, int, int, int, intptr, intptr
; res = WinUsb_ReadIsochPipeAsap(BufferHandle, Offset, Length, ContinueStream, NumberOfPackets, varptr(IsoPacketDescriptors), varptr(Overlapped))
; BufferHandle : void* -> "intptr"
; Offset : DWORD -> "int"
; Length : DWORD -> "int"
; ContinueStream : BOOL -> "int"
; NumberOfPackets : DWORD -> "int"
; IsoPacketDescriptors : USBD_ISO_PACKET_DESCRIPTOR* out -> "intptr"
; Overlapped : OVERLAPPED* optional -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

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

var (
	winusb = windows.NewLazySystemDLL("WINUSB.dll")
	procWinUsb_ReadIsochPipeAsap = winusb.NewProc("WinUsb_ReadIsochPipeAsap")
)

// BufferHandle (void*), Offset (DWORD), Length (DWORD), ContinueStream (BOOL), NumberOfPackets (DWORD), IsoPacketDescriptors (USBD_ISO_PACKET_DESCRIPTOR* out), Overlapped (OVERLAPPED* optional)
r1, _, err := procWinUsb_ReadIsochPipeAsap.Call(
	uintptr(BufferHandle),
	uintptr(Offset),
	uintptr(Length),
	uintptr(ContinueStream),
	uintptr(NumberOfPackets),
	uintptr(IsoPacketDescriptors),
	uintptr(Overlapped),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function WinUsb_ReadIsochPipeAsap(
  BufferHandle: Pointer;   // void*
  Offset: DWORD;   // DWORD
  Length: DWORD;   // DWORD
  ContinueStream: BOOL;   // BOOL
  NumberOfPackets: DWORD;   // DWORD
  IsoPacketDescriptors: Pointer;   // USBD_ISO_PACKET_DESCRIPTOR* out
  Overlapped: Pointer   // OVERLAPPED* optional
): BOOL; stdcall;
  external 'WINUSB.dll' name 'WinUsb_ReadIsochPipeAsap';

result := DllCall("WINUSB\WinUsb_ReadIsochPipeAsap"
    , "Ptr", BufferHandle   ; void*
    , "UInt", Offset   ; DWORD
    , "UInt", Length   ; DWORD
    , "Int", ContinueStream   ; BOOL
    , "UInt", NumberOfPackets   ; DWORD
    , "Ptr", IsoPacketDescriptors   ; USBD_ISO_PACKET_DESCRIPTOR* out
    , "Ptr", Overlapped   ; OVERLAPPED* optional
    , "Int")   ; return: BOOL

●WinUsb_ReadIsochPipeAsap(BufferHandle, Offset, Length, ContinueStream, NumberOfPackets, IsoPacketDescriptors, Overlapped) = DLL("WINUSB.dll", "bool WinUsb_ReadIsochPipeAsap(void*, dword, dword, bool, dword, void*, void*)")
# 呼び出し: WinUsb_ReadIsochPipeAsap(BufferHandle, Offset, Length, ContinueStream, NumberOfPackets, IsoPacketDescriptors, Overlapped)
# BufferHandle : void* -> "void*"
# Offset : DWORD -> "dword"
# Length : DWORD -> "dword"
# ContinueStream : BOOL -> "bool"
# NumberOfPackets : DWORD -> "dword"
# IsoPacketDescriptors : USBD_ISO_PACKET_DESCRIPTOR* out -> "void*"
# Overlapped : OVERLAPPED* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。