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

WinUsb_GetOverlappedResult

関数
非同期転送(オーバーラップ操作)の結果を取得する。
DLLWINUSB.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL WinUsb_GetOverlappedResult(
    WINUSB_INTERFACE_HANDLE InterfaceHandle,
    OVERLAPPED* lpOverlapped,
    DWORD* lpNumberOfBytesTransferred,
    BOOL bWait
);

パラメーター

名前方向説明
InterfaceHandleWINUSB_INTERFACE_HANDLEin非同期処理を待機する対象のWinUSBインターフェイスハンドル。
lpOverlappedOVERLAPPED*in対象の非同期操作で使用したOVERLAPPED構造体へのポインタ。
lpNumberOfBytesTransferredDWORD*out実際に転送されたバイト数を受け取る出力先ポインタ。
bWaitBOOLin完了まで待機するならTRUE、即座に返すならFALSE。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

WinUsb_GetOverlappedResult = ctypes.windll.winusb.WinUsb_GetOverlappedResult
WinUsb_GetOverlappedResult.restype = wintypes.BOOL
WinUsb_GetOverlappedResult.argtypes = [
    wintypes.HANDLE,  # InterfaceHandle : WINUSB_INTERFACE_HANDLE
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED*
    ctypes.POINTER(wintypes.DWORD),  # lpNumberOfBytesTransferred : DWORD* out
    wintypes.BOOL,  # bWait : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	winusb = windows.NewLazySystemDLL("WINUSB.dll")
	procWinUsb_GetOverlappedResult = winusb.NewProc("WinUsb_GetOverlappedResult")
)

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

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

typedef WinUsb_GetOverlappedResultNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>, Int32);
typedef WinUsb_GetOverlappedResultDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>, int);
final WinUsb_GetOverlappedResult = DynamicLibrary.open('WINUSB.dll')
    .lookupFunction<WinUsb_GetOverlappedResultNative, WinUsb_GetOverlappedResultDart>('WinUsb_GetOverlappedResult');
// InterfaceHandle : WINUSB_INTERFACE_HANDLE -> Pointer<Void>
// lpOverlapped : OVERLAPPED* -> Pointer<Void>
// lpNumberOfBytesTransferred : DWORD* out -> Pointer<Uint32>
// bWait : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinUsb_GetOverlappedResult(
  InterfaceHandle: THandle;   // WINUSB_INTERFACE_HANDLE
  lpOverlapped: Pointer;   // OVERLAPPED*
  lpNumberOfBytesTransferred: Pointer;   // DWORD* out
  bWait: BOOL   // BOOL
): BOOL; stdcall;
  external 'WINUSB.dll' name 'WinUsb_GetOverlappedResult';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinUsb_GetOverlappedResult"
  c_WinUsb_GetOverlappedResult :: Ptr () -> Ptr () -> Ptr Word32 -> CInt -> IO CInt
-- InterfaceHandle : WINUSB_INTERFACE_HANDLE -> Ptr ()
-- lpOverlapped : OVERLAPPED* -> Ptr ()
-- lpNumberOfBytesTransferred : DWORD* out -> Ptr Word32
-- bWait : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winusb_getoverlappedresult =
  foreign "WinUsb_GetOverlappedResult"
    ((ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> int32_t @-> returning int32_t)
(* InterfaceHandle : WINUSB_INTERFACE_HANDLE -> (ptr void) *)
(* lpOverlapped : OVERLAPPED* -> (ptr void) *)
(* lpNumberOfBytesTransferred : DWORD* out -> (ptr uint32_t) *)
(* bWait : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winusb (t "WINUSB.dll"))
(cffi:use-foreign-library winusb)

(cffi:defcfun ("WinUsb_GetOverlappedResult" win-usb-get-overlapped-result :convention :stdcall) :int32
  (interface-handle :pointer)   ; WINUSB_INTERFACE_HANDLE
  (lp-overlapped :pointer)   ; OVERLAPPED*
  (lp-number-of-bytes-transferred :pointer)   ; DWORD* out
  (b-wait :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinUsb_GetOverlappedResult = Win32::API::More->new('WINUSB',
    'BOOL WinUsb_GetOverlappedResult(HANDLE InterfaceHandle, LPVOID lpOverlapped, LPVOID lpNumberOfBytesTransferred, BOOL bWait)');
# my $ret = $WinUsb_GetOverlappedResult->Call($InterfaceHandle, $lpOverlapped, $lpNumberOfBytesTransferred, $bWait);
# InterfaceHandle : WINUSB_INTERFACE_HANDLE -> HANDLE
# lpOverlapped : OVERLAPPED* -> LPVOID
# lpNumberOfBytesTransferred : DWORD* out -> LPVOID
# bWait : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型