SetActivePwrScheme

関数

指定の電源スキームをアクティブに設定する。

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

シグネチャ

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

BOOLEAN SetActivePwrScheme(
    DWORD uiID,
    GLOBAL_POWER_POLICY* pGlobalPowerPolicy,   // optional
    POWER_POLICY* pPowerPolicy   // optional
);

パラメーター

名前	型	方向	説明
uiID	DWORD	in	アクティブにする電源プランのインデックス。
pGlobalPowerPolicy	GLOBAL_POWER_POLICY*	inoptional	省略可能な GLOBAL_POWER_POLICY 構造体へのポインター。電源プランがアクティブになる際にマージされるグローバル電源ポリシー設定を指定します。
pPowerPolicy	POWER_POLICY*	inoptional	省略可能な POWER_POLICY 構造体へのポインター。電源プランがアクティブになる際にマージされる電源ポリシー設定を指定します。

戻り値の型: BOOLEAN

公式ドキュメント

アクティブな電源プランを設定します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

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

解説(Remarks)

システム構成に長期的な変更を加えるには、この関数を使用します。アプリケーションがタスクを実行している間、一時的にシステムの動作を維持するには、SetThreadExecutionState 関数を使用してください。

uiID で指定された電源プランが存在しない場合、関数は 0 を返します。

lpGlobalPowerPolicy が NULL の場合、関数は WriteGlobalPwrPolicy によって設定された現在のグローバル電源ポリシー設定を使用します。NULL でない場合は、指定された構造体内の設定が現在のグローバル電源ポリシー設定を置き換えます。

lpPowerPolicy が NULL の場合、関数はその電源プランの現在の電源ポリシー設定を使用します。NULL でない場合は、指定された構造体内の設定が現在の電源ポリシー設定を置き換えます。

PowrProf.h の使用に関する詳細については、電源プランを参照してください。

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

各言語での呼び出し定義

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

BOOLEAN SetActivePwrScheme(
    DWORD uiID,
    GLOBAL_POWER_POLICY* pGlobalPowerPolicy,   // optional
    POWER_POLICY* pPowerPolicy   // optional
);

[return: MarshalAs(UnmanagedType.U1)]
[DllImport("POWRPROF.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetActivePwrScheme(
    uint uiID,   // DWORD
    IntPtr pGlobalPowerPolicy,   // GLOBAL_POWER_POLICY* optional
    IntPtr pPowerPolicy   // POWER_POLICY* optional
);

<DllImport("POWRPROF.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetActivePwrScheme(
    uiID As UInteger,   ' DWORD
    pGlobalPowerPolicy As IntPtr,   ' GLOBAL_POWER_POLICY* optional
    pPowerPolicy As IntPtr   ' POWER_POLICY* optional
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

SetActivePwrScheme = ctypes.windll.powrprof.SetActivePwrScheme
SetActivePwrScheme.restype = wintypes.BOOLEAN
SetActivePwrScheme.argtypes = [
    wintypes.DWORD,  # uiID : DWORD
    ctypes.c_void_p,  # pGlobalPowerPolicy : GLOBAL_POWER_POLICY* optional
    ctypes.c_void_p,  # pPowerPolicy : POWER_POLICY* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "powrprof")]
extern "system" {
    fn SetActivePwrScheme(
        uiID: u32,  // DWORD
        pGlobalPowerPolicy: *mut GLOBAL_POWER_POLICY,  // GLOBAL_POWER_POLICY* optional
        pPowerPolicy: *mut POWER_POLICY  // POWER_POLICY* optional
    ) -> 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 SetActivePwrScheme(uint uiID, IntPtr pGlobalPowerPolicy, IntPtr pPowerPolicy);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_SetActivePwrScheme' -Namespace Win32 -PassThru
# $api::SetActivePwrScheme(uiID, pGlobalPowerPolicy, pPowerPolicy)

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

出力引数:

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