ホーム › System.Power › PowerReadDescription

PowerReadDescription

関数

電源スキームや設定の説明文を読み取る。

DLLPOWRPROF.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR PowerReadDescription(
    HKEY RootPowerKey,   // optional
    const GUID* SchemeGuid,   // optional
    const GUID* SubGroupOfPowerSettingsGuid,   // optional
    const GUID* PowerSettingGuid,   // optional
    BYTE* Buffer,   // optional
    DWORD* BufferSize
);

パラメーター

名前	型	方向
RootPowerKey	HKEY	inoptional
SchemeGuid	GUID*	inoptional
SubGroupOfPowerSettingsGuid	GUID*	inoptional
PowerSettingGuid	GUID*	inoptional
Buffer	BYTE*	outoptional
BufferSize	DWORD*	inout

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

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

WIN32_ERROR PowerReadDescription(
    HKEY RootPowerKey,   // optional
    const GUID* SchemeGuid,   // optional
    const GUID* SubGroupOfPowerSettingsGuid,   // optional
    const GUID* PowerSettingGuid,   // optional
    BYTE* Buffer,   // optional
    DWORD* BufferSize
);

[DllImport("POWRPROF.dll", ExactSpelling = true)]
static extern uint PowerReadDescription(
    IntPtr RootPowerKey,   // HKEY optional
    IntPtr SchemeGuid,   // GUID* optional
    IntPtr SubGroupOfPowerSettingsGuid,   // GUID* optional
    IntPtr PowerSettingGuid,   // GUID* optional
    IntPtr Buffer,   // BYTE* optional, out
    ref uint BufferSize   // DWORD* in/out
);

<DllImport("POWRPROF.dll", ExactSpelling:=True)>
Public Shared Function PowerReadDescription(
    RootPowerKey As IntPtr,   ' HKEY optional
    SchemeGuid As IntPtr,   ' GUID* optional
    SubGroupOfPowerSettingsGuid As IntPtr,   ' GUID* optional
    PowerSettingGuid As IntPtr,   ' GUID* optional
    Buffer As IntPtr,   ' BYTE* optional, out
    ByRef BufferSize As UInteger   ' DWORD* in/out
) As UInteger
End Function

' RootPowerKey : HKEY optional
' SchemeGuid : GUID* optional
' SubGroupOfPowerSettingsGuid : GUID* optional
' PowerSettingGuid : GUID* optional
' Buffer : BYTE* optional, out
' BufferSize : DWORD* in/out
Declare PtrSafe Function PowerReadDescription Lib "powrprof" ( _
    ByVal RootPowerKey As LongPtr, _
    ByVal SchemeGuid As LongPtr, _
    ByVal SubGroupOfPowerSettingsGuid As LongPtr, _
    ByVal PowerSettingGuid As LongPtr, _
    ByVal Buffer As LongPtr, _
    ByRef BufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PowerReadDescription = ctypes.windll.powrprof.PowerReadDescription
PowerReadDescription.restype = wintypes.DWORD
PowerReadDescription.argtypes = [
    wintypes.HANDLE,  # RootPowerKey : HKEY optional
    ctypes.c_void_p,  # SchemeGuid : GUID* optional
    ctypes.c_void_p,  # SubGroupOfPowerSettingsGuid : GUID* optional
    ctypes.c_void_p,  # PowerSettingGuid : GUID* optional
    ctypes.POINTER(ctypes.c_ubyte),  # Buffer : BYTE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # BufferSize : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('POWRPROF.dll')
PowerReadDescription = Fiddle::Function.new(
  lib['PowerReadDescription'],
  [
    Fiddle::TYPE_VOIDP,  # RootPowerKey : HKEY optional
    Fiddle::TYPE_VOIDP,  # SchemeGuid : GUID* optional
    Fiddle::TYPE_VOIDP,  # SubGroupOfPowerSettingsGuid : GUID* optional
    Fiddle::TYPE_VOIDP,  # PowerSettingGuid : GUID* optional
    Fiddle::TYPE_VOIDP,  # Buffer : BYTE* optional, out
    Fiddle::TYPE_VOIDP,  # BufferSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "powrprof")]
extern "system" {
    fn PowerReadDescription(
        RootPowerKey: *mut core::ffi::c_void,  // HKEY optional
        SchemeGuid: *const GUID,  // GUID* optional
        SubGroupOfPowerSettingsGuid: *const GUID,  // GUID* optional
        PowerSettingGuid: *const GUID,  // GUID* optional
        Buffer: *mut u8,  // BYTE* optional, out
        BufferSize: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("POWRPROF.dll")]
public static extern uint PowerReadDescription(IntPtr RootPowerKey, IntPtr SchemeGuid, IntPtr SubGroupOfPowerSettingsGuid, IntPtr PowerSettingGuid, IntPtr Buffer, ref uint BufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_PowerReadDescription' -Namespace Win32 -PassThru
# $api::PowerReadDescription(RootPowerKey, SchemeGuid, SubGroupOfPowerSettingsGuid, PowerSettingGuid, Buffer, BufferSize)

#uselib "POWRPROF.dll"
#func global PowerReadDescription "PowerReadDescription" sptr, sptr, sptr, sptr, sptr, sptr
; PowerReadDescription RootPowerKey, varptr(SchemeGuid), varptr(SubGroupOfPowerSettingsGuid), varptr(PowerSettingGuid), varptr(Buffer), varptr(BufferSize)   ; 戻り値は stat
; RootPowerKey : HKEY optional -> "sptr"
; SchemeGuid : GUID* optional -> "sptr"
; SubGroupOfPowerSettingsGuid : GUID* optional -> "sptr"
; PowerSettingGuid : GUID* optional -> "sptr"
; Buffer : BYTE* optional, out -> "sptr"
; BufferSize : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "POWRPROF.dll"
#cfunc global PowerReadDescription "PowerReadDescription" sptr, var, var, var, var, var
; res = PowerReadDescription(RootPowerKey, SchemeGuid, SubGroupOfPowerSettingsGuid, PowerSettingGuid, Buffer, BufferSize)
; RootPowerKey : HKEY optional -> "sptr"
; SchemeGuid : GUID* optional -> "var"
; SubGroupOfPowerSettingsGuid : GUID* optional -> "var"
; PowerSettingGuid : GUID* optional -> "var"
; Buffer : BYTE* optional, out -> "var"
; BufferSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "POWRPROF.dll"
#cfunc global PowerReadDescription "PowerReadDescription" sptr, sptr, sptr, sptr, sptr, sptr
; res = PowerReadDescription(RootPowerKey, varptr(SchemeGuid), varptr(SubGroupOfPowerSettingsGuid), varptr(PowerSettingGuid), varptr(Buffer), varptr(BufferSize))
; RootPowerKey : HKEY optional -> "sptr"
; SchemeGuid : GUID* optional -> "sptr"
; SubGroupOfPowerSettingsGuid : GUID* optional -> "sptr"
; PowerSettingGuid : GUID* optional -> "sptr"
; Buffer : BYTE* optional, out -> "sptr"
; BufferSize : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; WIN32_ERROR PowerReadDescription(HKEY RootPowerKey, GUID* SchemeGuid, GUID* SubGroupOfPowerSettingsGuid, GUID* PowerSettingGuid, BYTE* Buffer, DWORD* BufferSize)
#uselib "POWRPROF.dll"
#cfunc global PowerReadDescription "PowerReadDescription" intptr, var, var, var, var, var
; res = PowerReadDescription(RootPowerKey, SchemeGuid, SubGroupOfPowerSettingsGuid, PowerSettingGuid, Buffer, BufferSize)
; RootPowerKey : HKEY optional -> "intptr"
; SchemeGuid : GUID* optional -> "var"
; SubGroupOfPowerSettingsGuid : GUID* optional -> "var"
; PowerSettingGuid : GUID* optional -> "var"
; Buffer : BYTE* optional, out -> "var"
; BufferSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; WIN32_ERROR PowerReadDescription(HKEY RootPowerKey, GUID* SchemeGuid, GUID* SubGroupOfPowerSettingsGuid, GUID* PowerSettingGuid, BYTE* Buffer, DWORD* BufferSize)
#uselib "POWRPROF.dll"
#cfunc global PowerReadDescription "PowerReadDescription" intptr, intptr, intptr, intptr, intptr, intptr
; res = PowerReadDescription(RootPowerKey, varptr(SchemeGuid), varptr(SubGroupOfPowerSettingsGuid), varptr(PowerSettingGuid), varptr(Buffer), varptr(BufferSize))
; RootPowerKey : HKEY optional -> "intptr"
; SchemeGuid : GUID* optional -> "intptr"
; SubGroupOfPowerSettingsGuid : GUID* optional -> "intptr"
; PowerSettingGuid : GUID* optional -> "intptr"
; Buffer : BYTE* optional, out -> "intptr"
; BufferSize : DWORD* in/out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
	procPowerReadDescription = powrprof.NewProc("PowerReadDescription")
)

// RootPowerKey (HKEY optional), SchemeGuid (GUID* optional), SubGroupOfPowerSettingsGuid (GUID* optional), PowerSettingGuid (GUID* optional), Buffer (BYTE* optional, out), BufferSize (DWORD* in/out)
r1, _, err := procPowerReadDescription.Call(
	uintptr(RootPowerKey),
	uintptr(SchemeGuid),
	uintptr(SubGroupOfPowerSettingsGuid),
	uintptr(PowerSettingGuid),
	uintptr(Buffer),
	uintptr(BufferSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR

function PowerReadDescription(
  RootPowerKey: THandle;   // HKEY optional
  SchemeGuid: PGUID;   // GUID* optional
  SubGroupOfPowerSettingsGuid: PGUID;   // GUID* optional
  PowerSettingGuid: PGUID;   // GUID* optional
  Buffer: Pointer;   // BYTE* optional, out
  BufferSize: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'POWRPROF.dll' name 'PowerReadDescription';

result := DllCall("POWRPROF\PowerReadDescription"
    , "Ptr", RootPowerKey   ; HKEY optional
    , "Ptr", SchemeGuid   ; GUID* optional
    , "Ptr", SubGroupOfPowerSettingsGuid   ; GUID* optional
    , "Ptr", PowerSettingGuid   ; GUID* optional
    , "Ptr", Buffer   ; BYTE* optional, out
    , "Ptr", BufferSize   ; DWORD* in/out
    , "UInt")   ; return: WIN32_ERROR

●PowerReadDescription(RootPowerKey, SchemeGuid, SubGroupOfPowerSettingsGuid, PowerSettingGuid, Buffer, BufferSize) = DLL("POWRPROF.dll", "dword PowerReadDescription(void*, void*, void*, void*, void*, void*)")
# 呼び出し: PowerReadDescription(RootPowerKey, SchemeGuid, SubGroupOfPowerSettingsGuid, PowerSettingGuid, Buffer, BufferSize)
# RootPowerKey : HKEY optional -> "void*"
# SchemeGuid : GUID* optional -> "void*"
# SubGroupOfPowerSettingsGuid : GUID* optional -> "void*"
# PowerSettingGuid : GUID* optional -> "void*"
# Buffer : BYTE* optional, out -> "void*"
# BufferSize : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。