ホーム › System.Power › ReadProcessorPwrScheme

ReadProcessorPwrScheme

関数

指定スキームのプロセッサ電源ポリシーを読み取る。

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

シグネチャ

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

BOOLEAN ReadProcessorPwrScheme(
    DWORD uiID,
    MACHINE_PROCESSOR_POWER_POLICY* pMachineProcessorPowerPolicy
);

パラメーター

名前	型	方向	説明
uiID	DWORD	in	読み取る電源スキームのインデックス。
pMachineProcessorPowerPolicy	MACHINE_PROCESSOR_POWER_POLICY*	out	プロセッサ電源ポリシー設定を受け取る MACHINE_PROCESSOR_POWER_POLICY 構造体へのポインター。

戻り値の型: BOOLEAN

公式ドキュメント

指定された電源スキームのプロセッサ電源ポリシー設定を取得します。

戻り値

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

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

解説(Remarks)

MACHINE_PROCESSOR_POWER_POLICY 構造体には、システムが AC 電源またはバッテリ電源で動作している間に使用されるプロセッサ電源ポリシー設定が含まれます。

Windows Vista 以降では、システムのプロセッサの電源管理構成は GUID_PROCESSOR_SETTINGS_SUBGROUP 電源設定サブグループを通じて制御されます。個々の設定を列挙するには、PowerEnumerate 関数を使用します。

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 ReadProcessorPwrScheme(
    DWORD uiID,
    MACHINE_PROCESSOR_POWER_POLICY* pMachineProcessorPowerPolicy
);

[return: MarshalAs(UnmanagedType.U1)]
[DllImport("POWRPROF.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ReadProcessorPwrScheme(
    uint uiID,   // DWORD
    IntPtr pMachineProcessorPowerPolicy   // MACHINE_PROCESSOR_POWER_POLICY* out
);

<DllImport("POWRPROF.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadProcessorPwrScheme(
    uiID As UInteger,   ' DWORD
    pMachineProcessorPowerPolicy As IntPtr   ' MACHINE_PROCESSOR_POWER_POLICY* out
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

ReadProcessorPwrScheme = ctypes.windll.powrprof.ReadProcessorPwrScheme
ReadProcessorPwrScheme.restype = wintypes.BOOLEAN
ReadProcessorPwrScheme.argtypes = [
    wintypes.DWORD,  # uiID : DWORD
    ctypes.c_void_p,  # pMachineProcessorPowerPolicy : MACHINE_PROCESSOR_POWER_POLICY* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "powrprof")]
extern "system" {
    fn ReadProcessorPwrScheme(
        uiID: u32,  // DWORD
        pMachineProcessorPowerPolicy: *mut MACHINE_PROCESSOR_POWER_POLICY  // MACHINE_PROCESSOR_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 ReadProcessorPwrScheme(uint uiID, IntPtr pMachineProcessorPowerPolicy);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_ReadProcessorPwrScheme' -Namespace Win32 -PassThru
# $api::ReadProcessorPwrScheme(uiID, pMachineProcessorPowerPolicy)

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

出力引数:

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