ホーム › System.Power › PowerGetActiveScheme

PowerGetActiveScheme

関数

現在アクティブな電源プランのGUIDを取得する。

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

シグネチャ

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

WIN32_ERROR PowerGetActiveScheme(
    HKEY UserRootPowerKey,   // optional
    GUID** ActivePolicyGuid
);

パラメーター

名前	型	方向	説明
UserRootPowerKey	HKEY	inoptional	このパラメーターは将来の使用のために予約されており、NULL を設定する必要があります。
ActivePolicyGuid	GUID**	out	GUID 構造体へのポインターを受け取るポインターです。このメモリを解放するには LocalFree 関数を使用してください。

戻り値の型: WIN32_ERROR

公式ドキュメント

アクティブな電源スキームを取得し、そのスキームを識別する GUID を返します。

戻り値

呼び出しが成功した場合は ERROR_SUCCESS(ゼロ)を返し、失敗した場合はゼロ以外の値を返します。

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

各言語での呼び出し定義

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

WIN32_ERROR PowerGetActiveScheme(
    HKEY UserRootPowerKey,   // optional
    GUID** ActivePolicyGuid
);

[DllImport("POWRPROF.dll", ExactSpelling = true)]
static extern uint PowerGetActiveScheme(
    IntPtr UserRootPowerKey,   // HKEY optional
    IntPtr ActivePolicyGuid   // GUID** out
);

<DllImport("POWRPROF.dll", ExactSpelling:=True)>
Public Shared Function PowerGetActiveScheme(
    UserRootPowerKey As IntPtr,   ' HKEY optional
    ActivePolicyGuid As IntPtr   ' GUID** out
) As UInteger
End Function

' UserRootPowerKey : HKEY optional
' ActivePolicyGuid : GUID** out
Declare PtrSafe Function PowerGetActiveScheme Lib "powrprof" ( _
    ByVal UserRootPowerKey As LongPtr, _
    ByVal ActivePolicyGuid As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PowerGetActiveScheme = ctypes.windll.powrprof.PowerGetActiveScheme
PowerGetActiveScheme.restype = wintypes.DWORD
PowerGetActiveScheme.argtypes = [
    wintypes.HANDLE,  # UserRootPowerKey : HKEY optional
    ctypes.c_void_p,  # ActivePolicyGuid : GUID** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('POWRPROF.dll')
PowerGetActiveScheme = Fiddle::Function.new(
  lib['PowerGetActiveScheme'],
  [
    Fiddle::TYPE_VOIDP,  # UserRootPowerKey : HKEY optional
    Fiddle::TYPE_VOIDP,  # ActivePolicyGuid : GUID** out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "powrprof")]
extern "system" {
    fn PowerGetActiveScheme(
        UserRootPowerKey: *mut core::ffi::c_void,  // HKEY optional
        ActivePolicyGuid: *mut *mut GUID  // GUID** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("POWRPROF.dll")]
public static extern uint PowerGetActiveScheme(IntPtr UserRootPowerKey, IntPtr ActivePolicyGuid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_PowerGetActiveScheme' -Namespace Win32 -PassThru
# $api::PowerGetActiveScheme(UserRootPowerKey, ActivePolicyGuid)

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

出力引数:

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