Win32 API 日本語リファレンス
ホームSystem.Power › WriteGlobalPwrPolicy

WriteGlobalPwrPolicy

関数
グローバル電源ポリシーを書き込む。
DLLPOWRPROF.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOLEAN WriteGlobalPwrPolicy(
    GLOBAL_POWER_POLICY* pGlobalPowerPolicy
);

パラメーター

名前方向説明
pGlobalPowerPolicyGLOBAL_POWER_POLICY*in書き込むグローバル電源ポリシー設定を格納した GLOBAL_POWER_POLICY 構造体へのポインター。

戻り値の型: BOOLEAN

公式ドキュメント

グローバル電源ポリシー設定を書き込みます。

戻り値

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

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

解説(Remarks)

この関数は、既存のグローバル電源ポリシー設定をすべて置き換えます。各ユーザーは個別のグローバル電源スキームを持ち、これにはそのユーザーのすべての電源スキームに適用される電源ポリシー設定が含まれます。

Windows Vista 以降では、指定したスキームの電源設定を列挙するには 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 WriteGlobalPwrPolicy(
    GLOBAL_POWER_POLICY* pGlobalPowerPolicy
);
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("POWRPROF.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WriteGlobalPwrPolicy(
    IntPtr pGlobalPowerPolicy   // GLOBAL_POWER_POLICY*
);
<DllImport("POWRPROF.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WriteGlobalPwrPolicy(
    pGlobalPowerPolicy As IntPtr   ' GLOBAL_POWER_POLICY*
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function
' pGlobalPowerPolicy : GLOBAL_POWER_POLICY*
Declare PtrSafe Function WriteGlobalPwrPolicy Lib "powrprof" ( _
    ByVal pGlobalPowerPolicy As LongPtr) As Byte
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WriteGlobalPwrPolicy = ctypes.windll.powrprof.WriteGlobalPwrPolicy
WriteGlobalPwrPolicy.restype = wintypes.BOOLEAN
WriteGlobalPwrPolicy.argtypes = [
    ctypes.c_void_p,  # pGlobalPowerPolicy : GLOBAL_POWER_POLICY*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('POWRPROF.dll')
WriteGlobalPwrPolicy = Fiddle::Function.new(
  lib['WriteGlobalPwrPolicy'],
  [
    Fiddle::TYPE_VOIDP,  # pGlobalPowerPolicy : GLOBAL_POWER_POLICY*
  ],
  Fiddle::TYPE_CHAR)
#[link(name = "powrprof")]
extern "system" {
    fn WriteGlobalPwrPolicy(
        pGlobalPowerPolicy: *mut GLOBAL_POWER_POLICY  // GLOBAL_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 WriteGlobalPwrPolicy(IntPtr pGlobalPowerPolicy);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_WriteGlobalPwrPolicy' -Namespace Win32 -PassThru
# $api::WriteGlobalPwrPolicy(pGlobalPowerPolicy)
#uselib "POWRPROF.dll"
#func global WriteGlobalPwrPolicy "WriteGlobalPwrPolicy" sptr
; WriteGlobalPwrPolicy varptr(pGlobalPowerPolicy)   ; 戻り値は stat
; pGlobalPowerPolicy : GLOBAL_POWER_POLICY* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "POWRPROF.dll"
#cfunc global WriteGlobalPwrPolicy "WriteGlobalPwrPolicy" var
; res = WriteGlobalPwrPolicy(pGlobalPowerPolicy)
; pGlobalPowerPolicy : GLOBAL_POWER_POLICY* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOLEAN WriteGlobalPwrPolicy(GLOBAL_POWER_POLICY* pGlobalPowerPolicy)
#uselib "POWRPROF.dll"
#cfunc global WriteGlobalPwrPolicy "WriteGlobalPwrPolicy" var
; res = WriteGlobalPwrPolicy(pGlobalPowerPolicy)
; pGlobalPowerPolicy : GLOBAL_POWER_POLICY* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
	procWriteGlobalPwrPolicy = powrprof.NewProc("WriteGlobalPwrPolicy")
)

// pGlobalPowerPolicy (GLOBAL_POWER_POLICY*)
r1, _, err := procWriteGlobalPwrPolicy.Call(
	uintptr(pGlobalPowerPolicy),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOLEAN
function WriteGlobalPwrPolicy(
  pGlobalPowerPolicy: Pointer   // GLOBAL_POWER_POLICY*
): ByteBool; stdcall;
  external 'POWRPROF.dll' name 'WriteGlobalPwrPolicy';
result := DllCall("POWRPROF\WriteGlobalPwrPolicy"
    , "Ptr", pGlobalPowerPolicy   ; GLOBAL_POWER_POLICY*
    , "Char")   ; return: BOOLEAN
●WriteGlobalPwrPolicy(pGlobalPowerPolicy) = DLL("POWRPROF.dll", "byte WriteGlobalPwrPolicy(void*)")
# 呼び出し: WriteGlobalPwrPolicy(pGlobalPowerPolicy)
# pGlobalPowerPolicy : GLOBAL_POWER_POLICY* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "powrprof" fn WriteGlobalPwrPolicy(
    pGlobalPowerPolicy: [*c]GLOBAL_POWER_POLICY // GLOBAL_POWER_POLICY*
) callconv(std.os.windows.WINAPI) u8;
proc WriteGlobalPwrPolicy(
    pGlobalPowerPolicy: ptr GLOBAL_POWER_POLICY  # GLOBAL_POWER_POLICY*
): uint8 {.importc: "WriteGlobalPwrPolicy", stdcall, dynlib: "POWRPROF.dll".}
pragma(lib, "powrprof");
extern(Windows)
ubyte WriteGlobalPwrPolicy(
    GLOBAL_POWER_POLICY* pGlobalPowerPolicy   // GLOBAL_POWER_POLICY*
);
ccall((:WriteGlobalPwrPolicy, "POWRPROF.dll"), stdcall, UInt8,
      (Ptr{GLOBAL_POWER_POLICY},),
      pGlobalPowerPolicy)
# pGlobalPowerPolicy : GLOBAL_POWER_POLICY* -> Ptr{GLOBAL_POWER_POLICY}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint8_t WriteGlobalPwrPolicy(
    void* pGlobalPowerPolicy);
]]
local powrprof = ffi.load("powrprof")
-- powrprof.WriteGlobalPwrPolicy(pGlobalPowerPolicy)
-- pGlobalPowerPolicy : GLOBAL_POWER_POLICY*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('POWRPROF.dll');
const WriteGlobalPwrPolicy = lib.func('__stdcall', 'WriteGlobalPwrPolicy', 'uint8_t', ['void *']);
// WriteGlobalPwrPolicy(pGlobalPowerPolicy)
// pGlobalPowerPolicy : GLOBAL_POWER_POLICY* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("POWRPROF.dll", {
  WriteGlobalPwrPolicy: { parameters: ["pointer"], result: "u8" },
});
// lib.symbols.WriteGlobalPwrPolicy(pGlobalPowerPolicy)
// pGlobalPowerPolicy : GLOBAL_POWER_POLICY* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint8_t WriteGlobalPwrPolicy(
    void* pGlobalPowerPolicy);
C, "POWRPROF.dll");
// $ffi->WriteGlobalPwrPolicy(pGlobalPowerPolicy);
// pGlobalPowerPolicy : GLOBAL_POWER_POLICY*
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Powrprof extends StdCallLibrary {
    Powrprof INSTANCE = Native.load("powrprof", Powrprof.class);
    byte WriteGlobalPwrPolicy(
        Pointer pGlobalPowerPolicy   // GLOBAL_POWER_POLICY*
    );
}
@[Link("powrprof")]
lib LibPOWRPROF
  fun WriteGlobalPwrPolicy = WriteGlobalPwrPolicy(
    pGlobalPowerPolicy : GLOBAL_POWER_POLICY*   # GLOBAL_POWER_POLICY*
  ) : UInt8
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WriteGlobalPwrPolicyNative = Uint8 Function(Pointer<Void>);
typedef WriteGlobalPwrPolicyDart = int Function(Pointer<Void>);
final WriteGlobalPwrPolicy = DynamicLibrary.open('POWRPROF.dll')
    .lookupFunction<WriteGlobalPwrPolicyNative, WriteGlobalPwrPolicyDart>('WriteGlobalPwrPolicy');
// pGlobalPowerPolicy : GLOBAL_POWER_POLICY* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WriteGlobalPwrPolicy(
  pGlobalPowerPolicy: Pointer   // GLOBAL_POWER_POLICY*
): ByteBool; stdcall;
  external 'POWRPROF.dll' name 'WriteGlobalPwrPolicy';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WriteGlobalPwrPolicy"
  c_WriteGlobalPwrPolicy :: Ptr () -> IO Word8
-- pGlobalPowerPolicy : GLOBAL_POWER_POLICY* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let writeglobalpwrpolicy =
  foreign "WriteGlobalPwrPolicy"
    ((ptr void) @-> returning uint8_t)
(* pGlobalPowerPolicy : GLOBAL_POWER_POLICY* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library powrprof (t "POWRPROF.dll"))
(cffi:use-foreign-library powrprof)

(cffi:defcfun ("WriteGlobalPwrPolicy" write-global-pwr-policy :convention :stdcall) :uint8
  (p-global-power-policy :pointer))   ; GLOBAL_POWER_POLICY*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WriteGlobalPwrPolicy = Win32::API::More->new('POWRPROF',
    'BYTE WriteGlobalPwrPolicy(LPVOID pGlobalPowerPolicy)');
# my $ret = $WriteGlobalPwrPolicy->Call($pGlobalPowerPolicy);
# pGlobalPowerPolicy : GLOBAL_POWER_POLICY* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型