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
);

パラメーター

名前	型	方向	説明
InterfaceHandle	WINUSB_INTERFACE_HANDLE	in	パイプが関連付けられているエンドポイントを含むインターフェイスへの不透明なハンドル。最初のインターフェイス内のエンドポイントに関連付けられたパイプからデータを読み取るには、WinUsb_Initialize が返したハンドルを使用します。それ以外のインターフェイスについては、WinUsb_GetAssociatedInterface で取得した対象インターフェイスのハンドルを使用します。
PipeID	BYTE	in	PipeID は、エンドポイント記述子の bEndpointAddress フィールドに対応します。このフィールドのレイアウトについては、USB Technology にある「Universal Serial Bus Specification Revision 2.0」の Table 9-13 を参照してください。bEndpointAddress フィールドでは、ビット 7 がエンドポイントの方向を示します。OUT の場合は 0、IN の場合は 1 です。
Buffer	BYTE*	outoptional	読み取られたデータを受け取る、呼び出し元が割り当てたバッファー。
BufferLength	DWORD	in	読み取る最大バイト数。この値は Buffer のサイズ (バイト単位) 以下である必要があります。
LengthTransferred	DWORD*	outoptional	Buffer に実際にコピーされたバイト数を受け取る ULONG 変数へのポインター。詳細については、「解説」を参照してください。
Overlapped	OVERLAPPED*	inoptional	非同期操作に使用する OVERLAPPED 構造体への省略可能なポインター。このパラメーターを指定した場合、WinUsb_ReadPipe は操作の完了を同期的に待たずに、直ちに制御を返します。操作が完了すると、イベントがシグナル状態になります。

戻り値の型: BOOL

公式ドキュメント

WinUsb_ReadPipe 関数は、指定されたパイプからデータを読み取ります。

戻り値

WinUsb_ReadPipe は、操作に成功した場合は TRUE を返します。それ以外の場合、この関数は FALSE を返し、呼び出し元は GetLastError を呼び出すことで記録されたエラーを取得できます。

GetLastError は次のエラーコードを返すことがあります。

戻り値	説明
ERROR_INVALID_HANDLE	呼び出し元が InterfaceHandle パラメーターに NULL を渡しました。
ERROR_IO_PENDING	オーバーラップ I/O 操作が進行中で、まだ完了していません。オーバーラップ操作を直ちに完了できない場合、この関数は FALSE を返し、GetLastError 関数は ERROR_IO_PENDING を返して、操作がバックグラウンドで実行中であることを示します。操作の成否を確認するには、WinUsb_GetOverlappedResult を呼び出してください。
ERROR_NOT_ENOUGH_MEMORY	操作を実行するためのメモリが不足しています。
ERROR_SEM_TIMEOUT	WinUsb_ReadPipe によって USB スタックで開始された読み取り操作が、完了する前にタイムアウトしました。

解説(Remarks)

デバイスから返されるデータが最大転送長を超える場合、WinUSB は要求を最大転送長以下の小さな要求に分割し、順番に送信します。転送長がエンドポイントの最大パケットサイズ (WINUSB_PIPE_INFORMATION 構造体の MaximumPacketSize メンバーで取得できます) の倍数でない場合、WinUSB は転送サイズを MaximumPacketSize の次の倍数まで増やします。

読み取り要求では、USB のパケットサイズは転送に影響しません。デバイスがクライアントのバッファーに対して大きすぎるパケットで応答した場合、読み取り要求の動作はパイプに設定されているポリシーの種類に応じて決まります。パイプのポリシーの種類が ALLOW_PARTIAL_READS の場合、WinUSB は残りのデータを次の転送の先頭に追加します。ALLOW_PARTIAL_READS が設定されていない場合、読み取り要求は失敗します。ポリシーの種類の詳細については、WinUSB Functions for Pipe Policy Modification を参照してください。

アプリケーションが Overlapped パラメーターに NULL を渡す場合 (同期操作)、読み取り操作が出力データを生成しないときでも、LengthTransferred が NULL でないことを保証する必要があります。

Overlapped が NULL でない場合 (非同期操作)、LengthTransferred には NULL を指定できます。オーバーラップ操作では (かつ LengthTransferred が NULL 以外の値である場合)、WinUsb_ReadPipe が制御を返した後に LengthTransferred で受け取る値は、オーバーラップ操作が完了するまで意味を持ちません。パイプから実際に読み取られたバイト数を取得するには、WinUsb_GetOverlappedResult を呼び出してください。

エンドポイントに利用可能なデータがない場合 (パイプが空の場合)、WinUsb_ReadPipe はパイプにデータが入るまで制御を返しません。エラー状態が発生した場合、またはアプリケーションが指定したタイムアウトが経過した場合、WinUsb_ReadPipe は常に FALSE を返します。その戻り値の実際の理由を判断するには、必ず GetLastError を呼び出してください。たとえば、次のような場合は GetLastError のエラー値が実際の理由を示します。

アプリケーションがパイプポリシーでタイムアウト値を指定し、そのタイムアウトが経過した場合、WinUsb_ReadPipe は FALSE を返し、GetLastError は ERROR_SEM_TIMEOUT を返します。
パイプからのデータ読み取り中にエラー状態が発生した場合、WinUsb_ReadPipe は FALSE を返し、GetLastError は ERROR_GEN_FAILURE を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// 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 方式にも切替可。#uselib "WINUSB.dll"
#cfunc global WinUsb_ReadPipe "WinUsb_ReadPipe" sptr, int, sptr, int, sptr, sptr
; res = WinUsb_ReadPipe(InterfaceHandle, PipeID, varptr(Buffer), BufferLength, varptr(LengthTransferred), varptr(Overlapped))
; InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "sptr"
; PipeID : BYTE -> "int"
; Buffer : BYTE* optional, out -> "sptr"
; BufferLength : DWORD -> "int"
; LengthTransferred : DWORD* optional, out -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。