ホーム › System.Power › PowerWritePossibleDescription

PowerWritePossibleDescription

関数

電源設定の選択可能な値の説明文を書き込む。

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

シグネチャ

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

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

パラメーター

名前	型	方向
RootPowerKey	HKEY	inoptional
SubGroupOfPowerSettingsGuid	GUID*	inoptional
PowerSettingGuid	GUID*	inoptional
PossibleSettingIndex	DWORD	in
Buffer	BYTE*	in
BufferSize	DWORD	in

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

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

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

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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

出力引数:

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

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

var (
	powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
	procPowerWritePossibleDescription = powrprof.NewProc("PowerWritePossibleDescription")
)

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

function PowerWritePossibleDescription(
  RootPowerKey: THandle;   // HKEY optional
  SubGroupOfPowerSettingsGuid: PGUID;   // GUID* optional
  PowerSettingGuid: PGUID;   // GUID* optional
  PossibleSettingIndex: DWORD;   // DWORD
  Buffer: Pointer;   // BYTE*
  BufferSize: DWORD   // DWORD
): DWORD; stdcall;
  external 'POWRPROF.dll' name 'PowerWritePossibleDescription';

result := DllCall("POWRPROF\PowerWritePossibleDescription"
    , "Ptr", RootPowerKey   ; HKEY optional
    , "Ptr", SubGroupOfPowerSettingsGuid   ; GUID* optional
    , "Ptr", PowerSettingGuid   ; GUID* optional
    , "UInt", PossibleSettingIndex   ; DWORD
    , "Ptr", Buffer   ; BYTE*
    , "UInt", BufferSize   ; DWORD
    , "UInt")   ; return: WIN32_ERROR

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