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

WinUsb_SetPipePolicy

関数
指定したパイプの転送ポリシーを設定する。
DLLWINUSB.dll呼出規約winapiSetLastErrorあり
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL WinUsb_SetPipePolicy(
    WINUSB_INTERFACE_HANDLE InterfaceHandle,
    BYTE PipeID,
    WINUSB_PIPE_POLICY PolicyType,
    DWORD ValueLength,
    void* Value
);

パラメーター

名前型方向説明
InterfaceHandleWINUSB_INTERFACE_HANDLEinパイプポリシーを設定する対象のWinUSBインターフェイスハンドル。
PipeIDBYTEin対象パイプのエンドポイントアドレス。最上位ビットで方向を示す。
PolicyTypeWINUSB_PIPE_POLICYin設定するポリシーの種類(PIPE_TRANSFER_TIMEOUT等)。
ValueLengthDWORDinValueが指すデータのバイト数。
Valuevoid*in設定するポリシー値を格納したバッファへのポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL WinUsb_SetPipePolicy(
    WINUSB_INTERFACE_HANDLE InterfaceHandle,
    BYTE PipeID,
    WINUSB_PIPE_POLICY PolicyType,
    DWORD ValueLength,
    void* Value
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINUSB.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinUsb_SetPipePolicy(
    IntPtr InterfaceHandle,   // WINUSB_INTERFACE_HANDLE
    byte PipeID,   // BYTE
    uint PolicyType,   // WINUSB_PIPE_POLICY
    uint ValueLength,   // DWORD
    IntPtr Value   // void*
);
<DllImport("WINUSB.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinUsb_SetPipePolicy(
    InterfaceHandle As IntPtr,   ' WINUSB_INTERFACE_HANDLE
    PipeID As Byte,   ' BYTE
    PolicyType As UInteger,   ' WINUSB_PIPE_POLICY
    ValueLength As UInteger,   ' DWORD
    Value As IntPtr   ' void*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' InterfaceHandle : WINUSB_INTERFACE_HANDLE
' PipeID : BYTE
' PolicyType : WINUSB_PIPE_POLICY
' ValueLength : DWORD
' Value : void*
Declare PtrSafe Function WinUsb_SetPipePolicy Lib "winusb" ( _
    ByVal InterfaceHandle As LongPtr, _
    ByVal PipeID As Byte, _
    ByVal PolicyType As Long, _
    ByVal ValueLength As Long, _
    ByVal Value As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WinUsb_SetPipePolicy = ctypes.windll.winusb.WinUsb_SetPipePolicy
WinUsb_SetPipePolicy.restype = wintypes.BOOL
WinUsb_SetPipePolicy.argtypes = [
    wintypes.HANDLE,  # InterfaceHandle : WINUSB_INTERFACE_HANDLE
    ctypes.c_ubyte,  # PipeID : BYTE
    wintypes.DWORD,  # PolicyType : WINUSB_PIPE_POLICY
    wintypes.DWORD,  # ValueLength : DWORD
    ctypes.POINTER(None),  # Value : void*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINUSB.dll')
WinUsb_SetPipePolicy = Fiddle::Function.new(
  lib['WinUsb_SetPipePolicy'],
  [
    Fiddle::TYPE_VOIDP,  # InterfaceHandle : WINUSB_INTERFACE_HANDLE
    -Fiddle::TYPE_CHAR,  # PipeID : BYTE
    -Fiddle::TYPE_INT,  # PolicyType : WINUSB_PIPE_POLICY
    -Fiddle::TYPE_INT,  # ValueLength : DWORD
    Fiddle::TYPE_VOIDP,  # Value : void*
  ],
  Fiddle::TYPE_INT)
#[link(name = "winusb")]
extern "system" {
    fn WinUsb_SetPipePolicy(
        InterfaceHandle: *mut core::ffi::c_void,  // WINUSB_INTERFACE_HANDLE
        PipeID: u8,  // BYTE
        PolicyType: u32,  // WINUSB_PIPE_POLICY
        ValueLength: u32,  // DWORD
        Value: *mut ()  // void*
    ) -> 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_SetPipePolicy(IntPtr InterfaceHandle, byte PipeID, uint PolicyType, uint ValueLength, IntPtr Value);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINUSB_WinUsb_SetPipePolicy' -Namespace Win32 -PassThru
# $api::WinUsb_SetPipePolicy(InterfaceHandle, PipeID, PolicyType, ValueLength, Value)
#uselib "WINUSB.dll"
#func global WinUsb_SetPipePolicy "WinUsb_SetPipePolicy" sptr, sptr, sptr, sptr, sptr
; WinUsb_SetPipePolicy InterfaceHandle, PipeID, PolicyType, ValueLength, Value   ; 戻り値は stat
; InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "sptr"
; PipeID : BYTE -> "sptr"
; PolicyType : WINUSB_PIPE_POLICY -> "sptr"
; ValueLength : DWORD -> "sptr"
; Value : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINUSB.dll"
#cfunc global WinUsb_SetPipePolicy "WinUsb_SetPipePolicy" sptr, int, int, int, sptr
; res = WinUsb_SetPipePolicy(InterfaceHandle, PipeID, PolicyType, ValueLength, Value)
; InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "sptr"
; PipeID : BYTE -> "int"
; PolicyType : WINUSB_PIPE_POLICY -> "int"
; ValueLength : DWORD -> "int"
; Value : void* -> "sptr"
; BOOL WinUsb_SetPipePolicy(WINUSB_INTERFACE_HANDLE InterfaceHandle, BYTE PipeID, WINUSB_PIPE_POLICY PolicyType, DWORD ValueLength, void* Value)
#uselib "WINUSB.dll"
#cfunc global WinUsb_SetPipePolicy "WinUsb_SetPipePolicy" intptr, int, int, int, intptr
; res = WinUsb_SetPipePolicy(InterfaceHandle, PipeID, PolicyType, ValueLength, Value)
; InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "intptr"
; PipeID : BYTE -> "int"
; PolicyType : WINUSB_PIPE_POLICY -> "int"
; ValueLength : DWORD -> "int"
; Value : void* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winusb = windows.NewLazySystemDLL("WINUSB.dll")
	procWinUsb_SetPipePolicy = winusb.NewProc("WinUsb_SetPipePolicy")
)

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

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

typedef WinUsb_SetPipePolicyNative = Int32 Function(Pointer<Void>, Uint8, Uint32, Uint32, Pointer<Void>);
typedef WinUsb_SetPipePolicyDart = int Function(Pointer<Void>, int, int, int, Pointer<Void>);
final WinUsb_SetPipePolicy = DynamicLibrary.open('WINUSB.dll')
    .lookupFunction<WinUsb_SetPipePolicyNative, WinUsb_SetPipePolicyDart>('WinUsb_SetPipePolicy');
// InterfaceHandle : WINUSB_INTERFACE_HANDLE -> Pointer<Void>
// PipeID : BYTE -> Uint8
// PolicyType : WINUSB_PIPE_POLICY -> Uint32
// ValueLength : DWORD -> Uint32
// Value : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinUsb_SetPipePolicy(
  InterfaceHandle: THandle;   // WINUSB_INTERFACE_HANDLE
  PipeID: Byte;   // BYTE
  PolicyType: DWORD;   // WINUSB_PIPE_POLICY
  ValueLength: DWORD;   // DWORD
  Value: Pointer   // void*
): BOOL; stdcall;
  external 'WINUSB.dll' name 'WinUsb_SetPipePolicy';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinUsb_SetPipePolicy"
  c_WinUsb_SetPipePolicy :: Ptr () -> Word8 -> Word32 -> Word32 -> Ptr () -> IO CInt
-- InterfaceHandle : WINUSB_INTERFACE_HANDLE -> Ptr ()
-- PipeID : BYTE -> Word8
-- PolicyType : WINUSB_PIPE_POLICY -> Word32
-- ValueLength : DWORD -> Word32
-- Value : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winusb_setpipepolicy =
  foreign "WinUsb_SetPipePolicy"
    ((ptr void) @-> uint8_t @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* InterfaceHandle : WINUSB_INTERFACE_HANDLE -> (ptr void) *)
(* PipeID : BYTE -> uint8_t *)
(* PolicyType : WINUSB_PIPE_POLICY -> uint32_t *)
(* ValueLength : DWORD -> uint32_t *)
(* Value : void* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winusb (t "WINUSB.dll"))
(cffi:use-foreign-library winusb)

(cffi:defcfun ("WinUsb_SetPipePolicy" win-usb-set-pipe-policy :convention :stdcall) :int32
  (interface-handle :pointer)   ; WINUSB_INTERFACE_HANDLE
  (pipe-id :uint8)   ; BYTE
  (policy-type :uint32)   ; WINUSB_PIPE_POLICY
  (value-length :uint32)   ; DWORD
  (value :pointer))   ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinUsb_SetPipePolicy = Win32::API::More->new('WINUSB',
    'BOOL WinUsb_SetPipePolicy(HANDLE InterfaceHandle, BYTE PipeID, DWORD PolicyType, DWORD ValueLength, LPVOID Value)');
# my $ret = $WinUsb_SetPipePolicy->Call($InterfaceHandle, $PipeID, $PolicyType, $ValueLength, $Value);
# InterfaceHandle : WINUSB_INTERFACE_HANDLE -> HANDLE
# PipeID : BYTE -> BYTE
# PolicyType : WINUSB_PIPE_POLICY -> DWORD
# ValueLength : DWORD -> DWORD
# Value : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型