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

GetPwrCapabilities

関数
システムの電源管理機能の対応状況を取得する。
DLLPOWRPROF.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOLEAN GetPwrCapabilities(
    SYSTEM_POWER_CAPABILITIES* lpspc
);

パラメーター

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

戻り値の型: BOOLEAN

公式ドキュメント

システムの電源機能に関する情報を取得します。

戻り値

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

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

解説(Remarks)

この関数は、現在のシステム電源管理のハードウェアリソースおよび機能に関する詳細情報を取得します。これには、電源ボタン、リッドスイッチ、バッテリーなどのハードウェア機能の有無に関する情報が含まれます。返されるその他の詳細には、動的に変化し得る現在の電源管理機能や構成に関する情報も含まれます。たとえば、現在サポートされている最小のスリープ状態(新しいドライバーがシステムに導入されると変化する場合があります)や、システムの休止状態ファイルの有無などです。

この情報は、SystemPowerCapabilities レベルを使用して CallNtPowerInformation 関数からも取得できます。

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 GetPwrCapabilities(
    SYSTEM_POWER_CAPABILITIES* lpspc
);
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("POWRPROF.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetPwrCapabilities(
    IntPtr lpspc   // SYSTEM_POWER_CAPABILITIES* out
);
<DllImport("POWRPROF.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetPwrCapabilities(
    lpspc As IntPtr   ' SYSTEM_POWER_CAPABILITIES* out
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function
' lpspc : SYSTEM_POWER_CAPABILITIES* out
Declare PtrSafe Function GetPwrCapabilities Lib "powrprof" ( _
    ByVal lpspc As LongPtr) As Byte
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
	procGetPwrCapabilities = powrprof.NewProc("GetPwrCapabilities")
)

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

extern "powrprof" fn GetPwrCapabilities(
    lpspc: [*c]SYSTEM_POWER_CAPABILITIES // SYSTEM_POWER_CAPABILITIES* out
) callconv(std.os.windows.WINAPI) u8;
proc GetPwrCapabilities(
    lpspc: ptr SYSTEM_POWER_CAPABILITIES  # SYSTEM_POWER_CAPABILITIES* out
): uint8 {.importc: "GetPwrCapabilities", stdcall, dynlib: "POWRPROF.dll".}
pragma(lib, "powrprof");
extern(Windows)
ubyte GetPwrCapabilities(
    SYSTEM_POWER_CAPABILITIES* lpspc   // SYSTEM_POWER_CAPABILITIES* out
);
ccall((:GetPwrCapabilities, "POWRPROF.dll"), stdcall, UInt8,
      (Ptr{SYSTEM_POWER_CAPABILITIES},),
      lpspc)
# lpspc : SYSTEM_POWER_CAPABILITIES* out -> Ptr{SYSTEM_POWER_CAPABILITIES}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint8_t GetPwrCapabilities(
    void* lpspc);
]]
local powrprof = ffi.load("powrprof")
-- powrprof.GetPwrCapabilities(lpspc)
-- lpspc : SYSTEM_POWER_CAPABILITIES* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('POWRPROF.dll');
const GetPwrCapabilities = lib.func('__stdcall', 'GetPwrCapabilities', 'uint8_t', ['void *']);
// GetPwrCapabilities(lpspc)
// lpspc : SYSTEM_POWER_CAPABILITIES* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("POWRPROF.dll", {
  GetPwrCapabilities: { parameters: ["pointer"], result: "u8" },
});
// lib.symbols.GetPwrCapabilities(lpspc)
// lpspc : SYSTEM_POWER_CAPABILITIES* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint8_t GetPwrCapabilities(
    void* lpspc);
C, "POWRPROF.dll");
// $ffi->GetPwrCapabilities(lpspc);
// lpspc : SYSTEM_POWER_CAPABILITIES* out
// 構造体/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 GetPwrCapabilities(
        Pointer lpspc   // SYSTEM_POWER_CAPABILITIES* out
    );
}
@[Link("powrprof")]
lib LibPOWRPROF
  fun GetPwrCapabilities = GetPwrCapabilities(
    lpspc : SYSTEM_POWER_CAPABILITIES*   # SYSTEM_POWER_CAPABILITIES* out
  ) : UInt8
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

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

関連項目

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