WritePwrScheme

関数

電源スキームの名前・説明・ポリシーを書き込む。

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

シグネチャ

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

BOOLEAN WritePwrScheme(
    DWORD* puiID,
    LPCWSTR lpszSchemeName,
    LPCWSTR lpszDescription,   // optional
    POWER_POLICY* lpScheme
);

パラメーター

名前	型	方向	説明
puiID	DWORD*	in	書き込む電源スキームのインデックス。同じインデックスを持つ電源スキームがすでに存在する場合は置き換えられます。存在しない場合は、新しい電源スキームが作成されます。
lpszSchemeName	LPCWSTR	in	電源スキームの名前。
lpszDescription	LPCWSTR	inoptional	電源スキームの説明。
lpScheme	POWER_POLICY*	in	書き込む電源ポリシー設定を含む POWER_POLICY 構造体へのポインター。

戻り値の型: BOOLEAN

公式ドキュメント

指定された電源スキームに固有のポリシー設定を書き込みます。

戻り値

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

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

解説(Remarks)

この変更は現在のシステム電源ポリシーには影響しません。この変更を現在のシステム電源ポリシーに適用するには、この電源スキームのインデックスを指定して SetActivePwrScheme 関数を呼び出します。

WritePwrScheme を使用して書き込まれた電源ポリシースキームは、システムレジストリハイブに永続的に保存され、電源オプションのコントロールパネルプログラムや、その後の電源スキーム API の呼び出しで引き続き使用できます。電源スキームをシステムから永続的に削除するには、 DeletePwrScheme 関数を呼び出します。

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 WritePwrScheme(
    DWORD* puiID,
    LPCWSTR lpszSchemeName,
    LPCWSTR lpszDescription,   // optional
    POWER_POLICY* lpScheme
);

[return: MarshalAs(UnmanagedType.U1)]
[DllImport("POWRPROF.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WritePwrScheme(
    ref uint puiID,   // DWORD*
    [MarshalAs(UnmanagedType.LPWStr)] string lpszSchemeName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpszDescription,   // LPCWSTR optional
    IntPtr lpScheme   // POWER_POLICY*
);

<DllImport("POWRPROF.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WritePwrScheme(
    ByRef puiID As UInteger,   ' DWORD*
    <MarshalAs(UnmanagedType.LPWStr)> lpszSchemeName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpszDescription As String,   ' LPCWSTR optional
    lpScheme As IntPtr   ' POWER_POLICY*
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function

' puiID : DWORD*
' lpszSchemeName : LPCWSTR
' lpszDescription : LPCWSTR optional
' lpScheme : POWER_POLICY*
Declare PtrSafe Function WritePwrScheme Lib "powrprof" ( _
    ByRef puiID As Long, _
    ByVal lpszSchemeName As LongPtr, _
    ByVal lpszDescription As LongPtr, _
    ByVal lpScheme As LongPtr) As Byte
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WritePwrScheme = ctypes.windll.powrprof.WritePwrScheme
WritePwrScheme.restype = wintypes.BOOLEAN
WritePwrScheme.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # puiID : DWORD*
    wintypes.LPCWSTR,  # lpszSchemeName : LPCWSTR
    wintypes.LPCWSTR,  # lpszDescription : LPCWSTR optional
    ctypes.c_void_p,  # lpScheme : POWER_POLICY*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('POWRPROF.dll')
WritePwrScheme = Fiddle::Function.new(
  lib['WritePwrScheme'],
  [
    Fiddle::TYPE_VOIDP,  # puiID : DWORD*
    Fiddle::TYPE_VOIDP,  # lpszSchemeName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpszDescription : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpScheme : POWER_POLICY*
  ],
  Fiddle::TYPE_CHAR)

#[link(name = "powrprof")]
extern "system" {
    fn WritePwrScheme(
        puiID: *mut u32,  // DWORD*
        lpszSchemeName: *const u16,  // LPCWSTR
        lpszDescription: *const u16,  // LPCWSTR optional
        lpScheme: *mut POWER_POLICY  // POWER_POLICY*
    ) -> 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 WritePwrScheme(ref uint puiID, [MarshalAs(UnmanagedType.LPWStr)] string lpszSchemeName, [MarshalAs(UnmanagedType.LPWStr)] string lpszDescription, IntPtr lpScheme);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_WritePwrScheme' -Namespace Win32 -PassThru
# $api::WritePwrScheme(puiID, lpszSchemeName, lpszDescription, lpScheme)

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

出力引数:

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