WinUsb_WritePipe

関数

指定したパイプへデータを書き込む。

DLLWINUSB.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL WinUsb_WritePipe(
    WINUSB_INTERFACE_HANDLE InterfaceHandle,
    BYTE PipeID,
    BYTE* Buffer,
    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 がエンドポイントの方向を示します。0 は OUT、1 は IN です。
Buffer	BYTE*	in	書き込むデータを含む、呼び出し元が割り当てたバッファーです。
BufferLength	DWORD	in	書き込むバイト数です。この値は Buffer のサイズ (バイト単位) 以下でなければなりません。
LengthTransferred	DWORD*	outoptional	パイプに実際に書き込まれたバイト数を受け取る ULONG 変数へのポインターです。詳細については、「解説」を参照してください。
Overlapped	OVERLAPPED*	inoptional	非同期操作に使用される OVERLAPPED 構造体への省略可能なポインターです。このパラメーターを指定すると、WinUsb_WritePipe は直ちに制御を返し、操作が完了した時点でイベントがシグナル状態になります。

戻り値の型: BOOL

公式ドキュメント

WinUsb_WritePipe 関数は、パイプにデータを書き込みます。

戻り値

WinUsb_WritePipe は、操作が成功した場合に 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_WritePipe が開始した書き込み操作が、完了する前に USB スタックでタイムアウトしました。

解説(Remarks)

書き込み要求を作成するには、アプリケーションはバッファーを割り当て、デバイスに書き込みたいデータをそこに格納し、WinUsb_WritePipe を呼び出してホストコントローラーにそのバッファーを送信する必要があります。

RAW_IO が設定されている場合、バッファーのサイズには次の制限が適用されます。

バッファー長は、エンドポイントの最大パケットサイズの倍数でなければなりません。
長さは、WinUsb_GetPipePolicy で取得した MAXIMUM_TRANSFER_SIZE の値以下でなければなりません。

パイプのポリシータイプとして RAW_IO が設定されていない場合、バッファーのサイズに制限はありません。バッファーのサイズが MAXIMUM_TRANSFER_SIZE で報告される最大転送長を超える場合、WinUSB は要求をより小さな要求に分割し、ホストコントローラーに順次送出します。

長さが 0 のデータを含む書き込み要求は、USB スタックの下位に転送されます。

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_WritePipe(
    WINUSB_INTERFACE_HANDLE InterfaceHandle,
    BYTE PipeID,
    BYTE* Buffer,
    DWORD BufferLength,
    DWORD* LengthTransferred,   // optional
    OVERLAPPED* Overlapped   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINUSB.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinUsb_WritePipe(
    IntPtr InterfaceHandle,   // WINUSB_INTERFACE_HANDLE
    byte PipeID,   // BYTE
    IntPtr Buffer,   // BYTE*
    uint BufferLength,   // DWORD
    IntPtr LengthTransferred,   // DWORD* optional, out
    IntPtr Overlapped   // OVERLAPPED* optional
);

<DllImport("WINUSB.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinUsb_WritePipe(
    InterfaceHandle As IntPtr,   ' WINUSB_INTERFACE_HANDLE
    PipeID As Byte,   ' BYTE
    Buffer As IntPtr,   ' BYTE*
    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*
' BufferLength : DWORD
' LengthTransferred : DWORD* optional, out
' Overlapped : OVERLAPPED* optional
Declare PtrSafe Function WinUsb_WritePipe 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_WritePipe = ctypes.windll.winusb.WinUsb_WritePipe
WinUsb_WritePipe.restype = wintypes.BOOL
WinUsb_WritePipe.argtypes = [
    wintypes.HANDLE,  # InterfaceHandle : WINUSB_INTERFACE_HANDLE
    ctypes.c_ubyte,  # PipeID : BYTE
    ctypes.POINTER(ctypes.c_ubyte),  # Buffer : BYTE*
    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_WritePipe = Fiddle::Function.new(
  lib['WinUsb_WritePipe'],
  [
    Fiddle::TYPE_VOIDP,  # InterfaceHandle : WINUSB_INTERFACE_HANDLE
    -Fiddle::TYPE_CHAR,  # PipeID : BYTE
    Fiddle::TYPE_VOIDP,  # Buffer : BYTE*
    -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_WritePipe(
        InterfaceHandle: *mut core::ffi::c_void,  // WINUSB_INTERFACE_HANDLE
        PipeID: u8,  // BYTE
        Buffer: *mut u8,  // BYTE*
        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_WritePipe(IntPtr InterfaceHandle, byte PipeID, IntPtr Buffer, uint BufferLength, IntPtr LengthTransferred, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINUSB_WinUsb_WritePipe' -Namespace Win32 -PassThru
# $api::WinUsb_WritePipe(InterfaceHandle, PipeID, Buffer, BufferLength, LengthTransferred, Overlapped)

#uselib "WINUSB.dll"
#func global WinUsb_WritePipe "WinUsb_WritePipe" sptr, sptr, sptr, sptr, sptr, sptr
; WinUsb_WritePipe InterfaceHandle, PipeID, varptr(Buffer), BufferLength, varptr(LengthTransferred), varptr(Overlapped)   ; 戻り値は stat
; InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "sptr"
; PipeID : BYTE -> "sptr"
; Buffer : BYTE* -> "sptr"
; BufferLength : DWORD -> "sptr"
; LengthTransferred : DWORD* optional, out -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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