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

WinUsb_GetPowerPolicy

関数
WinUSBデバイスの電源管理ポリシーを取得する。
DLLWINUSB.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL WinUsb_GetPowerPolicy(
    WINUSB_INTERFACE_HANDLE InterfaceHandle,
    WINUSB_POWER_POLICY PolicyType,
    DWORD* ValueLength,
    void* Value
);

パラメーター

名前方向説明
InterfaceHandleWINUSB_INTERFACE_HANDLEin電源ポリシーを取得する対象のWinUSBインターフェイスハンドル。
PolicyTypeWINUSB_POWER_POLICYin取得する電源ポリシーの種類(AUTO_SUSPEND/SUSPEND_DELAY)。
ValueLengthDWORD*inout入力でValueのサイズ、出力で実際の格納バイト数を返すポインタ。
Valuevoid*out取得した電源ポリシー値を格納するバッファへのポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL WinUsb_GetPowerPolicy(
    WINUSB_INTERFACE_HANDLE InterfaceHandle,
    WINUSB_POWER_POLICY PolicyType,
    DWORD* ValueLength,
    void* Value
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINUSB.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinUsb_GetPowerPolicy(
    IntPtr InterfaceHandle,   // WINUSB_INTERFACE_HANDLE
    uint PolicyType,   // WINUSB_POWER_POLICY
    ref uint ValueLength,   // DWORD* in/out
    IntPtr Value   // void* out
);
<DllImport("WINUSB.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinUsb_GetPowerPolicy(
    InterfaceHandle As IntPtr,   ' WINUSB_INTERFACE_HANDLE
    PolicyType As UInteger,   ' WINUSB_POWER_POLICY
    ByRef ValueLength As UInteger,   ' DWORD* in/out
    Value As IntPtr   ' void* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' InterfaceHandle : WINUSB_INTERFACE_HANDLE
' PolicyType : WINUSB_POWER_POLICY
' ValueLength : DWORD* in/out
' Value : void* out
Declare PtrSafe Function WinUsb_GetPowerPolicy Lib "winusb" ( _
    ByVal InterfaceHandle As LongPtr, _
    ByVal PolicyType As Long, _
    ByRef 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_GetPowerPolicy = ctypes.windll.winusb.WinUsb_GetPowerPolicy
WinUsb_GetPowerPolicy.restype = wintypes.BOOL
WinUsb_GetPowerPolicy.argtypes = [
    wintypes.HANDLE,  # InterfaceHandle : WINUSB_INTERFACE_HANDLE
    wintypes.DWORD,  # PolicyType : WINUSB_POWER_POLICY
    ctypes.POINTER(wintypes.DWORD),  # ValueLength : DWORD* in/out
    ctypes.POINTER(None),  # Value : void* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	winusb = windows.NewLazySystemDLL("WINUSB.dll")
	procWinUsb_GetPowerPolicy = winusb.NewProc("WinUsb_GetPowerPolicy")
)

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

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

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

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

let winusb_getpowerpolicy =
  foreign "WinUsb_GetPowerPolicy"
    ((ptr void) @-> uint32_t @-> (ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* InterfaceHandle : WINUSB_INTERFACE_HANDLE -> (ptr void) *)
(* PolicyType : WINUSB_POWER_POLICY -> uint32_t *)
(* ValueLength : DWORD* in/out -> (ptr uint32_t) *)
(* Value : void* out -> (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_GetPowerPolicy" win-usb-get-power-policy :convention :stdcall) :int32
  (interface-handle :pointer)   ; WINUSB_INTERFACE_HANDLE
  (policy-type :uint32)   ; WINUSB_POWER_POLICY
  (value-length :pointer)   ; DWORD* in/out
  (value :pointer))   ; void* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinUsb_GetPowerPolicy = Win32::API::More->new('WINUSB',
    'BOOL WinUsb_GetPowerPolicy(HANDLE InterfaceHandle, DWORD PolicyType, LPVOID ValueLength, LPVOID Value)');
# my $ret = $WinUsb_GetPowerPolicy->Call($InterfaceHandle, $PolicyType, $ValueLength, $Value);
# InterfaceHandle : WINUSB_INTERFACE_HANDLE -> HANDLE
# PolicyType : WINUSB_POWER_POLICY -> DWORD
# ValueLength : DWORD* in/out -> LPVOID
# Value : void* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型