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

ReadGlobalPwrPolicy

関数
現在のグローバル電源ポリシーを読み取る。
DLLPOWRPROF.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOLEAN ReadGlobalPwrPolicy(
    GLOBAL_POWER_POLICY* pGlobalPowerPolicy
);

パラメーター

名前方向説明
pGlobalPowerPolicyGLOBAL_POWER_POLICY*in情報を受け取る GLOBAL_POWER_POLICY 構造体へのポインター。

戻り値の型: BOOLEAN

公式ドキュメント

現在のグローバル電源ポリシー設定を取得します。

戻り値

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

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

解説(Remarks)

GLOBAL_POWER_POLICY 構造体には、すべての電源スキームに共通するポリシー設定が含まれます。この構造体には、ユーザーポリシー設定とコンピューターポリシー設定の両方が含まれます。

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 ReadGlobalPwrPolicy(
    GLOBAL_POWER_POLICY* pGlobalPowerPolicy
);
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("POWRPROF.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ReadGlobalPwrPolicy(
    IntPtr pGlobalPowerPolicy   // GLOBAL_POWER_POLICY*
);
<DllImport("POWRPROF.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadGlobalPwrPolicy(
    pGlobalPowerPolicy As IntPtr   ' GLOBAL_POWER_POLICY*
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function
' pGlobalPowerPolicy : GLOBAL_POWER_POLICY*
Declare PtrSafe Function ReadGlobalPwrPolicy 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

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

var (
	powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
	procReadGlobalPwrPolicy = powrprof.NewProc("ReadGlobalPwrPolicy")
)

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

extern "powrprof" fn ReadGlobalPwrPolicy(
    pGlobalPowerPolicy: [*c]GLOBAL_POWER_POLICY // GLOBAL_POWER_POLICY*
) callconv(std.os.windows.WINAPI) u8;
proc ReadGlobalPwrPolicy(
    pGlobalPowerPolicy: ptr GLOBAL_POWER_POLICY  # GLOBAL_POWER_POLICY*
): uint8 {.importc: "ReadGlobalPwrPolicy", stdcall, dynlib: "POWRPROF.dll".}
pragma(lib, "powrprof");
extern(Windows)
ubyte ReadGlobalPwrPolicy(
    GLOBAL_POWER_POLICY* pGlobalPowerPolicy   // GLOBAL_POWER_POLICY*
);
ccall((:ReadGlobalPwrPolicy, "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 ReadGlobalPwrPolicy(
    void* pGlobalPowerPolicy);
]]
local powrprof = ffi.load("powrprof")
-- powrprof.ReadGlobalPwrPolicy(pGlobalPowerPolicy)
-- pGlobalPowerPolicy : GLOBAL_POWER_POLICY*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('POWRPROF.dll');
const ReadGlobalPwrPolicy = lib.func('__stdcall', 'ReadGlobalPwrPolicy', 'uint8_t', ['void *']);
// ReadGlobalPwrPolicy(pGlobalPowerPolicy)
// pGlobalPowerPolicy : GLOBAL_POWER_POLICY* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("POWRPROF.dll", {
  ReadGlobalPwrPolicy: { parameters: ["pointer"], result: "u8" },
});
// lib.symbols.ReadGlobalPwrPolicy(pGlobalPowerPolicy)
// pGlobalPowerPolicy : GLOBAL_POWER_POLICY* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint8_t ReadGlobalPwrPolicy(
    void* pGlobalPowerPolicy);
C, "POWRPROF.dll");
// $ffi->ReadGlobalPwrPolicy(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 ReadGlobalPwrPolicy(
        Pointer pGlobalPowerPolicy   // GLOBAL_POWER_POLICY*
    );
}
@[Link("powrprof")]
lib LibPOWRPROF
  fun ReadGlobalPwrPolicy = ReadGlobalPwrPolicy(
    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 ReadGlobalPwrPolicyNative = Uint8 Function(Pointer<Void>);
typedef ReadGlobalPwrPolicyDart = int Function(Pointer<Void>);
final ReadGlobalPwrPolicy = DynamicLibrary.open('POWRPROF.dll')
    .lookupFunction<ReadGlobalPwrPolicyNative, ReadGlobalPwrPolicyDart>('ReadGlobalPwrPolicy');
// pGlobalPowerPolicy : GLOBAL_POWER_POLICY* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ReadGlobalPwrPolicy(
  pGlobalPowerPolicy: Pointer   // GLOBAL_POWER_POLICY*
): ByteBool; stdcall;
  external 'POWRPROF.dll' name 'ReadGlobalPwrPolicy';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let readglobalpwrpolicy =
  foreign "ReadGlobalPwrPolicy"
    ((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 ("ReadGlobalPwrPolicy" read-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 $ReadGlobalPwrPolicy = Win32::API::More->new('POWRPROF',
    'BYTE ReadGlobalPwrPolicy(LPVOID pGlobalPowerPolicy)');
# my $ret = $ReadGlobalPwrPolicy->Call($pGlobalPowerPolicy);
# pGlobalPowerPolicy : GLOBAL_POWER_POLICY* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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