ホーム › System.Power › DevicePowerEnumDevices
DevicePowerEnumDevices
関数電源管理機能を持つデバイスを列挙する。
シグネチャ
// POWRPROF.dll
#include <windows.h>
BOOLEAN DevicePowerEnumDevices(
DWORD QueryIndex,
DWORD QueryInterpretationFlags,
DWORD QueryFlags,
BYTE* pReturnBuffer, // optional
DWORD* pBufferSize
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| QueryIndex | DWORD | in | 要求するデバイスのインデックス。最初の呼び出しでは、この値を 0 にします。 | ||||||||||||||||||||||||||||||||||||||||
| QueryInterpretationFlags | DWORD | in | 検索結果に適用する条件。
| ||||||||||||||||||||||||||||||||||||||||
| QueryFlags | DWORD | in | クエリの条件。
| ||||||||||||||||||||||||||||||||||||||||
| pReturnBuffer | BYTE* | outoptional | 要求された情報を受け取るバッファへのポインター。 | ||||||||||||||||||||||||||||||||||||||||
| pBufferSize | DWORD* | inout | 戻りバッファのサイズ(バイト単位)。 注意 pReturnBuffer が NULL の場合、
pBufferSize にはデータを返すために必要なサイズが格納されます。
|
戻り値の型: BOOLEAN
公式ドキュメント
指定された条件を満たすシステム上のデバイスを列挙します。
戻り値
関数が成功した場合、戻り値は 0 以外の値です。
関数が失敗した場合、戻り値は 0 です。
解説(Remarks)
QueryFlags パラメーターの値を組み合わせて、2 つ以上の条件を サポートするデバイスをクエリできます。たとえば、QueryFlags パラメーターとして PDCAP_D3_SUPPORTED | PDCAP_D1_SUPPORTED を渡すと、 関数は D3 または D1 のいずれかをサポートするデバイスをクエリします。
QueryFlags は、DEVICEPOWER_AND_OPERATION に設定された QueryInterpretationFlags と組み合わせて、要求されたすべての条件を サポートするデバイスのクエリを生成することもできます。たとえば、QueryFlags パラメーターとして PDCAP_D3_SUPPORTED | PDCAP_D1_SUPPORTED を渡し、 QueryInterpretationFlags パラメーターとして DEVICEPOWER_AND_OPERATION を渡すと、 関数は D3 と D1 の両方をサポートするデバイスをクエリします。
例
この関数を使用する例については、 Using the Device Power API を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// POWRPROF.dll
#include <windows.h>
BOOLEAN DevicePowerEnumDevices(
DWORD QueryIndex,
DWORD QueryInterpretationFlags,
DWORD QueryFlags,
BYTE* pReturnBuffer, // optional
DWORD* pBufferSize
);[return: MarshalAs(UnmanagedType.U1)]
[DllImport("POWRPROF.dll", ExactSpelling = true)]
static extern bool DevicePowerEnumDevices(
uint QueryIndex, // DWORD
uint QueryInterpretationFlags, // DWORD
uint QueryFlags, // DWORD
IntPtr pReturnBuffer, // BYTE* optional, out
ref uint pBufferSize // DWORD* in/out
);<DllImport("POWRPROF.dll", ExactSpelling:=True)>
Public Shared Function DevicePowerEnumDevices(
QueryIndex As UInteger, ' DWORD
QueryInterpretationFlags As UInteger, ' DWORD
QueryFlags As UInteger, ' DWORD
pReturnBuffer As IntPtr, ' BYTE* optional, out
ByRef pBufferSize As UInteger ' DWORD* in/out
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function' QueryIndex : DWORD
' QueryInterpretationFlags : DWORD
' QueryFlags : DWORD
' pReturnBuffer : BYTE* optional, out
' pBufferSize : DWORD* in/out
Declare PtrSafe Function DevicePowerEnumDevices Lib "powrprof" ( _
ByVal QueryIndex As Long, _
ByVal QueryInterpretationFlags As Long, _
ByVal QueryFlags As Long, _
ByVal pReturnBuffer As LongPtr, _
ByRef pBufferSize As Long) As Byte
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
DevicePowerEnumDevices = ctypes.windll.powrprof.DevicePowerEnumDevices
DevicePowerEnumDevices.restype = wintypes.BOOLEAN
DevicePowerEnumDevices.argtypes = [
wintypes.DWORD, # QueryIndex : DWORD
wintypes.DWORD, # QueryInterpretationFlags : DWORD
wintypes.DWORD, # QueryFlags : DWORD
ctypes.POINTER(ctypes.c_ubyte), # pReturnBuffer : BYTE* optional, out
ctypes.POINTER(wintypes.DWORD), # pBufferSize : DWORD* in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('POWRPROF.dll')
DevicePowerEnumDevices = Fiddle::Function.new(
lib['DevicePowerEnumDevices'],
[
-Fiddle::TYPE_INT, # QueryIndex : DWORD
-Fiddle::TYPE_INT, # QueryInterpretationFlags : DWORD
-Fiddle::TYPE_INT, # QueryFlags : DWORD
Fiddle::TYPE_VOIDP, # pReturnBuffer : BYTE* optional, out
Fiddle::TYPE_VOIDP, # pBufferSize : DWORD* in/out
],
Fiddle::TYPE_CHAR)#[link(name = "powrprof")]
extern "system" {
fn DevicePowerEnumDevices(
QueryIndex: u32, // DWORD
QueryInterpretationFlags: u32, // DWORD
QueryFlags: u32, // DWORD
pReturnBuffer: *mut u8, // BYTE* optional, out
pBufferSize: *mut u32 // DWORD* in/out
) -> u8;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("POWRPROF.dll")]
public static extern bool DevicePowerEnumDevices(uint QueryIndex, uint QueryInterpretationFlags, uint QueryFlags, IntPtr pReturnBuffer, ref uint pBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_DevicePowerEnumDevices' -Namespace Win32 -PassThru
# $api::DevicePowerEnumDevices(QueryIndex, QueryInterpretationFlags, QueryFlags, pReturnBuffer, pBufferSize)#uselib "POWRPROF.dll"
#func global DevicePowerEnumDevices "DevicePowerEnumDevices" sptr, sptr, sptr, sptr, sptr
; DevicePowerEnumDevices QueryIndex, QueryInterpretationFlags, QueryFlags, varptr(pReturnBuffer), varptr(pBufferSize) ; 戻り値は stat
; QueryIndex : DWORD -> "sptr"
; QueryInterpretationFlags : DWORD -> "sptr"
; QueryFlags : DWORD -> "sptr"
; pReturnBuffer : BYTE* optional, out -> "sptr"
; pBufferSize : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "POWRPROF.dll" #cfunc global DevicePowerEnumDevices "DevicePowerEnumDevices" int, int, int, var, var ; res = DevicePowerEnumDevices(QueryIndex, QueryInterpretationFlags, QueryFlags, pReturnBuffer, pBufferSize) ; QueryIndex : DWORD -> "int" ; QueryInterpretationFlags : DWORD -> "int" ; QueryFlags : DWORD -> "int" ; pReturnBuffer : BYTE* optional, out -> "var" ; pBufferSize : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "POWRPROF.dll" #cfunc global DevicePowerEnumDevices "DevicePowerEnumDevices" int, int, int, sptr, sptr ; res = DevicePowerEnumDevices(QueryIndex, QueryInterpretationFlags, QueryFlags, varptr(pReturnBuffer), varptr(pBufferSize)) ; QueryIndex : DWORD -> "int" ; QueryInterpretationFlags : DWORD -> "int" ; QueryFlags : DWORD -> "int" ; pReturnBuffer : BYTE* optional, out -> "sptr" ; pBufferSize : DWORD* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOLEAN DevicePowerEnumDevices(DWORD QueryIndex, DWORD QueryInterpretationFlags, DWORD QueryFlags, BYTE* pReturnBuffer, DWORD* pBufferSize) #uselib "POWRPROF.dll" #cfunc global DevicePowerEnumDevices "DevicePowerEnumDevices" int, int, int, var, var ; res = DevicePowerEnumDevices(QueryIndex, QueryInterpretationFlags, QueryFlags, pReturnBuffer, pBufferSize) ; QueryIndex : DWORD -> "int" ; QueryInterpretationFlags : DWORD -> "int" ; QueryFlags : DWORD -> "int" ; pReturnBuffer : BYTE* optional, out -> "var" ; pBufferSize : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOLEAN DevicePowerEnumDevices(DWORD QueryIndex, DWORD QueryInterpretationFlags, DWORD QueryFlags, BYTE* pReturnBuffer, DWORD* pBufferSize) #uselib "POWRPROF.dll" #cfunc global DevicePowerEnumDevices "DevicePowerEnumDevices" int, int, int, intptr, intptr ; res = DevicePowerEnumDevices(QueryIndex, QueryInterpretationFlags, QueryFlags, varptr(pReturnBuffer), varptr(pBufferSize)) ; QueryIndex : DWORD -> "int" ; QueryInterpretationFlags : DWORD -> "int" ; QueryFlags : DWORD -> "int" ; pReturnBuffer : BYTE* optional, out -> "intptr" ; pBufferSize : DWORD* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
procDevicePowerEnumDevices = powrprof.NewProc("DevicePowerEnumDevices")
)
// QueryIndex (DWORD), QueryInterpretationFlags (DWORD), QueryFlags (DWORD), pReturnBuffer (BYTE* optional, out), pBufferSize (DWORD* in/out)
r1, _, err := procDevicePowerEnumDevices.Call(
uintptr(QueryIndex),
uintptr(QueryInterpretationFlags),
uintptr(QueryFlags),
uintptr(pReturnBuffer),
uintptr(pBufferSize),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLEANfunction DevicePowerEnumDevices(
QueryIndex: DWORD; // DWORD
QueryInterpretationFlags: DWORD; // DWORD
QueryFlags: DWORD; // DWORD
pReturnBuffer: Pointer; // BYTE* optional, out
pBufferSize: Pointer // DWORD* in/out
): ByteBool; stdcall;
external 'POWRPROF.dll' name 'DevicePowerEnumDevices';result := DllCall("POWRPROF\DevicePowerEnumDevices"
, "UInt", QueryIndex ; DWORD
, "UInt", QueryInterpretationFlags ; DWORD
, "UInt", QueryFlags ; DWORD
, "Ptr", pReturnBuffer ; BYTE* optional, out
, "Ptr", pBufferSize ; DWORD* in/out
, "Char") ; return: BOOLEAN●DevicePowerEnumDevices(QueryIndex, QueryInterpretationFlags, QueryFlags, pReturnBuffer, pBufferSize) = DLL("POWRPROF.dll", "byte DevicePowerEnumDevices(dword, dword, dword, void*, void*)")
# 呼び出し: DevicePowerEnumDevices(QueryIndex, QueryInterpretationFlags, QueryFlags, pReturnBuffer, pBufferSize)
# QueryIndex : DWORD -> "dword"
# QueryInterpretationFlags : DWORD -> "dword"
# QueryFlags : DWORD -> "dword"
# pReturnBuffer : BYTE* optional, out -> "void*"
# pBufferSize : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "powrprof" fn DevicePowerEnumDevices(
QueryIndex: u32, // DWORD
QueryInterpretationFlags: u32, // DWORD
QueryFlags: u32, // DWORD
pReturnBuffer: [*c]u8, // BYTE* optional, out
pBufferSize: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) u8;proc DevicePowerEnumDevices(
QueryIndex: uint32, # DWORD
QueryInterpretationFlags: uint32, # DWORD
QueryFlags: uint32, # DWORD
pReturnBuffer: ptr uint8, # BYTE* optional, out
pBufferSize: ptr uint32 # DWORD* in/out
): uint8 {.importc: "DevicePowerEnumDevices", stdcall, dynlib: "POWRPROF.dll".}pragma(lib, "powrprof");
extern(Windows)
ubyte DevicePowerEnumDevices(
uint QueryIndex, // DWORD
uint QueryInterpretationFlags, // DWORD
uint QueryFlags, // DWORD
ubyte* pReturnBuffer, // BYTE* optional, out
uint* pBufferSize // DWORD* in/out
);ccall((:DevicePowerEnumDevices, "POWRPROF.dll"), stdcall, UInt8,
(UInt32, UInt32, UInt32, Ptr{UInt8}, Ptr{UInt32}),
QueryIndex, QueryInterpretationFlags, QueryFlags, pReturnBuffer, pBufferSize)
# QueryIndex : DWORD -> UInt32
# QueryInterpretationFlags : DWORD -> UInt32
# QueryFlags : DWORD -> UInt32
# pReturnBuffer : BYTE* optional, out -> Ptr{UInt8}
# pBufferSize : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint8_t DevicePowerEnumDevices(
uint32_t QueryIndex,
uint32_t QueryInterpretationFlags,
uint32_t QueryFlags,
uint8_t* pReturnBuffer,
uint32_t* pBufferSize);
]]
local powrprof = ffi.load("powrprof")
-- powrprof.DevicePowerEnumDevices(QueryIndex, QueryInterpretationFlags, QueryFlags, pReturnBuffer, pBufferSize)
-- QueryIndex : DWORD
-- QueryInterpretationFlags : DWORD
-- QueryFlags : DWORD
-- pReturnBuffer : BYTE* optional, out
-- pBufferSize : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('POWRPROF.dll');
const DevicePowerEnumDevices = lib.func('__stdcall', 'DevicePowerEnumDevices', 'uint8_t', ['uint32_t', 'uint32_t', 'uint32_t', 'uint8_t *', 'uint32_t *']);
// DevicePowerEnumDevices(QueryIndex, QueryInterpretationFlags, QueryFlags, pReturnBuffer, pBufferSize)
// QueryIndex : DWORD -> 'uint32_t'
// QueryInterpretationFlags : DWORD -> 'uint32_t'
// QueryFlags : DWORD -> 'uint32_t'
// pReturnBuffer : BYTE* optional, out -> 'uint8_t *'
// pBufferSize : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("POWRPROF.dll", {
DevicePowerEnumDevices: { parameters: ["u32", "u32", "u32", "pointer", "pointer"], result: "u8" },
});
// lib.symbols.DevicePowerEnumDevices(QueryIndex, QueryInterpretationFlags, QueryFlags, pReturnBuffer, pBufferSize)
// QueryIndex : DWORD -> "u32"
// QueryInterpretationFlags : DWORD -> "u32"
// QueryFlags : DWORD -> "u32"
// pReturnBuffer : BYTE* optional, out -> "pointer"
// pBufferSize : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint8_t DevicePowerEnumDevices(
uint32_t QueryIndex,
uint32_t QueryInterpretationFlags,
uint32_t QueryFlags,
uint8_t* pReturnBuffer,
uint32_t* pBufferSize);
C, "POWRPROF.dll");
// $ffi->DevicePowerEnumDevices(QueryIndex, QueryInterpretationFlags, QueryFlags, pReturnBuffer, pBufferSize);
// QueryIndex : DWORD
// QueryInterpretationFlags : DWORD
// QueryFlags : DWORD
// pReturnBuffer : BYTE* optional, out
// pBufferSize : DWORD* in/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 Powrprof extends StdCallLibrary {
Powrprof INSTANCE = Native.load("powrprof", Powrprof.class);
byte DevicePowerEnumDevices(
int QueryIndex, // DWORD
int QueryInterpretationFlags, // DWORD
int QueryFlags, // DWORD
byte[] pReturnBuffer, // BYTE* optional, out
IntByReference pBufferSize // DWORD* in/out
);
}@[Link("powrprof")]
lib LibPOWRPROF
fun DevicePowerEnumDevices = DevicePowerEnumDevices(
QueryIndex : UInt32, # DWORD
QueryInterpretationFlags : UInt32, # DWORD
QueryFlags : UInt32, # DWORD
pReturnBuffer : UInt8*, # BYTE* optional, out
pBufferSize : UInt32* # DWORD* in/out
) : UInt8
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef DevicePowerEnumDevicesNative = Uint8 Function(Uint32, Uint32, Uint32, Pointer<Uint8>, Pointer<Uint32>);
typedef DevicePowerEnumDevicesDart = int Function(int, int, int, Pointer<Uint8>, Pointer<Uint32>);
final DevicePowerEnumDevices = DynamicLibrary.open('POWRPROF.dll')
.lookupFunction<DevicePowerEnumDevicesNative, DevicePowerEnumDevicesDart>('DevicePowerEnumDevices');
// QueryIndex : DWORD -> Uint32
// QueryInterpretationFlags : DWORD -> Uint32
// QueryFlags : DWORD -> Uint32
// pReturnBuffer : BYTE* optional, out -> Pointer<Uint8>
// pBufferSize : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function DevicePowerEnumDevices(
QueryIndex: DWORD; // DWORD
QueryInterpretationFlags: DWORD; // DWORD
QueryFlags: DWORD; // DWORD
pReturnBuffer: Pointer; // BYTE* optional, out
pBufferSize: Pointer // DWORD* in/out
): ByteBool; stdcall;
external 'POWRPROF.dll' name 'DevicePowerEnumDevices';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "DevicePowerEnumDevices"
c_DevicePowerEnumDevices :: Word32 -> Word32 -> Word32 -> Ptr Word8 -> Ptr Word32 -> IO Word8
-- QueryIndex : DWORD -> Word32
-- QueryInterpretationFlags : DWORD -> Word32
-- QueryFlags : DWORD -> Word32
-- pReturnBuffer : BYTE* optional, out -> Ptr Word8
-- pBufferSize : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let devicepowerenumdevices =
foreign "DevicePowerEnumDevices"
(uint32_t @-> uint32_t @-> uint32_t @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning uint8_t)
(* QueryIndex : DWORD -> uint32_t *)
(* QueryInterpretationFlags : DWORD -> uint32_t *)
(* QueryFlags : DWORD -> uint32_t *)
(* pReturnBuffer : BYTE* optional, out -> (ptr uint8_t) *)
(* pBufferSize : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library powrprof (t "POWRPROF.dll"))
(cffi:use-foreign-library powrprof)
(cffi:defcfun ("DevicePowerEnumDevices" device-power-enum-devices :convention :stdcall) :uint8
(query-index :uint32) ; DWORD
(query-interpretation-flags :uint32) ; DWORD
(query-flags :uint32) ; DWORD
(p-return-buffer :pointer) ; BYTE* optional, out
(p-buffer-size :pointer)) ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $DevicePowerEnumDevices = Win32::API::More->new('POWRPROF',
'BYTE DevicePowerEnumDevices(DWORD QueryIndex, DWORD QueryInterpretationFlags, DWORD QueryFlags, LPVOID pReturnBuffer, LPVOID pBufferSize)');
# my $ret = $DevicePowerEnumDevices->Call($QueryIndex, $QueryInterpretationFlags, $QueryFlags, $pReturnBuffer, $pBufferSize);
# QueryIndex : DWORD -> DWORD
# QueryInterpretationFlags : DWORD -> DWORD
# QueryFlags : DWORD -> DWORD
# pReturnBuffer : BYTE* optional, out -> LPVOID
# pBufferSize : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。