GetActivePwrScheme

関数

現在アクティブな電源スキームのIDを取得する。

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

シグネチャ

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

BOOLEAN GetActivePwrScheme(
    DWORD* puiID
);

パラメーター

名前	型	方向	説明
puiID	DWORD*	out	アクティブな電源スキームのインデックスを受け取る変数へのポインター。

戻り値の型: BOOLEAN

公式ドキュメント

アクティブな電源スキームのインデックスを取得します。

戻り値

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

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

解説(Remarks)

アクティブな電源スキームは、ユーザーが電源オプションのコントロールパネルプログラムを使用して新しい電源スキームを設定するか、アプリケーションが SetActivePwrScheme 関数を呼び出すまでアクティブなままになります。

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 GetActivePwrScheme(
    DWORD* puiID
);

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

<DllImport("POWRPROF.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetActivePwrScheme(
    <Out> ByRef puiID As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function

' puiID : DWORD* out
Declare PtrSafe Function GetActivePwrScheme Lib "powrprof" ( _
    ByRef puiID As Long) As Byte
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetActivePwrScheme = ctypes.windll.powrprof.GetActivePwrScheme
GetActivePwrScheme.restype = wintypes.BOOLEAN
GetActivePwrScheme.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # puiID : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('POWRPROF.dll')
GetActivePwrScheme = Fiddle::Function.new(
  lib['GetActivePwrScheme'],
  [
    Fiddle::TYPE_VOIDP,  # puiID : DWORD* out
  ],
  Fiddle::TYPE_CHAR)

#[link(name = "powrprof")]
extern "system" {
    fn GetActivePwrScheme(
        puiID: *mut u32  // DWORD* 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 GetActivePwrScheme(out uint puiID);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_GetActivePwrScheme' -Namespace Win32 -PassThru
# $api::GetActivePwrScheme(puiID)

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

出力引数:

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