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	電源ポリシー設定を受け取る POWER_POLICY 構造体へのポインターです。

戻り値の型: BOOLEAN

公式ドキュメント

指定した電源スキームに固有の電源ポリシー設定を取得します。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

指定した電源スキームが存在しない場合、関数は FALSE を返します。

システムが現在使用している電源ポリシー設定に関する情報を取得するには、 GetActivePwrScheme 関数を呼び出してください。現在の電源ポリシー設定に関する追加情報を取得するには、 CallNtPowerInformation 関数を呼び出してください。

Windows Vista 以降では、PowerEnumerate 関数を使用して指定したスキームの電源設定を列挙し、power read 関数を使用して個々の設定を取得してください。

PowrProf.h の使用方法の詳細については、Power Schemes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOLEAN ReadPwrScheme(
    DWORD uiID,
    POWER_POLICY* pPowerPolicy
);

[return: MarshalAs(UnmanagedType.U1)]
[DllImport("POWRPROF.dll", SetLastError = true, ExactSpelling = true)]
static extern bool 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 <MarshalAs(UnmanagedType.U1)> Boolean
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 = wintypes.BOOLEAN
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 = @"
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("POWRPROF.dll", SetLastError = true)]
public static extern bool 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(変数))。