ReadPwrScheme

関数

指定IDの電源スキームの電源ポリシーを読み取る。

DLLPOWRPROF.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOLEAN ReadPwrScheme(
    DWORD uiID,
    POWER_POLICY* pPowerPolicy
);

パラメーター

名前	型	方向
uiID	DWORD	in
pPowerPolicy	POWER_POLICY*	out

戻り値の型: BOOLEAN

各言語での呼び出し定義

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

BOOLEAN ReadPwrScheme(
    DWORD uiID,
    POWER_POLICY* pPowerPolicy
);

[DllImport("POWRPROF.dll", SetLastError = true, ExactSpelling = true)]
static extern byte ReadPwrScheme(
    uint uiID,   // DWORD
    IntPtr pPowerPolicy   // POWER_POLICY* out
);

<DllImport("POWRPROF.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadPwrScheme(
    uiID As UInteger,   ' DWORD
    pPowerPolicy As IntPtr   ' POWER_POLICY* out
) As Byte
End Function

' uiID : DWORD
' pPowerPolicy : POWER_POLICY* out
Declare PtrSafe Function ReadPwrScheme Lib "powrprof" ( _
    ByVal uiID As Long, _
    ByVal pPowerPolicy As LongPtr) As Byte
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ReadPwrScheme = ctypes.windll.powrprof.ReadPwrScheme
ReadPwrScheme.restype = ctypes.c_byte
ReadPwrScheme.argtypes = [
    wintypes.DWORD,  # uiID : DWORD
    ctypes.c_void_p,  # pPowerPolicy : POWER_POLICY* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('POWRPROF.dll')
ReadPwrScheme = Fiddle::Function.new(
  lib['ReadPwrScheme'],
  [
    -Fiddle::TYPE_INT,  # uiID : DWORD
    Fiddle::TYPE_VOIDP,  # pPowerPolicy : POWER_POLICY* out
  ],
  Fiddle::TYPE_CHAR)

#[link(name = "powrprof")]
extern "system" {
    fn ReadPwrScheme(
        uiID: u32,  // DWORD
        pPowerPolicy: *mut POWER_POLICY  // POWER_POLICY* out
    ) -> u8;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("POWRPROF.dll", SetLastError = true)]
public static extern byte ReadPwrScheme(uint uiID, IntPtr pPowerPolicy);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_ReadPwrScheme' -Namespace Win32 -PassThru
# $api::ReadPwrScheme(uiID, pPowerPolicy)

#uselib "POWRPROF.dll"
#func global ReadPwrScheme "ReadPwrScheme" sptr, sptr
; ReadPwrScheme uiID, varptr(pPowerPolicy)   ; 戻り値は stat
; uiID : DWORD -> "sptr"
; pPowerPolicy : POWER_POLICY* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "POWRPROF.dll"
#cfunc global ReadPwrScheme "ReadPwrScheme" int, var
; res = ReadPwrScheme(uiID, pPowerPolicy)
; uiID : DWORD -> "int"
; pPowerPolicy : POWER_POLICY* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "POWRPROF.dll"
#cfunc global ReadPwrScheme "ReadPwrScheme" int, sptr
; res = ReadPwrScheme(uiID, varptr(pPowerPolicy))
; uiID : DWORD -> "int"
; pPowerPolicy : POWER_POLICY* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOLEAN ReadPwrScheme(DWORD uiID, POWER_POLICY* pPowerPolicy)
#uselib "POWRPROF.dll"
#cfunc global ReadPwrScheme "ReadPwrScheme" int, var
; res = ReadPwrScheme(uiID, pPowerPolicy)
; uiID : DWORD -> "int"
; pPowerPolicy : POWER_POLICY* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOLEAN ReadPwrScheme(DWORD uiID, POWER_POLICY* pPowerPolicy)
#uselib "POWRPROF.dll"
#cfunc global ReadPwrScheme "ReadPwrScheme" int, intptr
; res = ReadPwrScheme(uiID, varptr(pPowerPolicy))
; uiID : DWORD -> "int"
; pPowerPolicy : POWER_POLICY* out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

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

var (
	powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
	procReadPwrScheme = powrprof.NewProc("ReadPwrScheme")
)

// uiID (DWORD), pPowerPolicy (POWER_POLICY* out)
r1, _, err := procReadPwrScheme.Call(
	uintptr(uiID),
	uintptr(pPowerPolicy),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOLEAN

function ReadPwrScheme(
  uiID: DWORD;   // DWORD
  pPowerPolicy: Pointer   // POWER_POLICY* out
): ByteBool; stdcall;
  external 'POWRPROF.dll' name 'ReadPwrScheme';

result := DllCall("POWRPROF\ReadPwrScheme"
    , "UInt", uiID   ; DWORD
    , "Ptr", pPowerPolicy   ; POWER_POLICY* out
    , "Char")   ; return: BOOLEAN

●ReadPwrScheme(uiID, pPowerPolicy) = DLL("POWRPROF.dll", "byte ReadPwrScheme(dword, void*)")
# 呼び出し: ReadPwrScheme(uiID, pPowerPolicy)
# uiID : DWORD -> "dword"
# pPowerPolicy : POWER_POLICY* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。