ホーム › System.Power › GetDevicePowerState

GetDevicePowerState

関数

指定デバイスが現在オン状態かどうかを取得する。

DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

BOOL GetDevicePowerState(
    HANDLE hDevice,
    BOOL* pfOn
);

パラメーター

名前	型	方向	説明
hDevice	HANDLE	in	デバイス上のオブジェクト(ファイルやソケットなど)へのハンドル、またはデバイス自体へのハンドル。
pfOn	BOOL*	out	電源状態を受け取る変数へのポインター。デバイスが動作状態の場合、この値は TRUE になります。それ以外の場合は FALSE です。

戻り値の型: BOOL

公式ドキュメント

指定したデバイスの現在の電源状態を取得します。

戻り値

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

関数が失敗した場合、戻り値は 0 です。

解説(Remarks)

アプリケーションは GetDevicePowerState を使用して、デバイスが動作状態にあるか低電力状態にあるかを判別できます。デバイスが低電力状態にある場合、そのデバイスにアクセスすると、I/O 要求がキューに入れられる、または失敗する、あるいはデバイスが動作状態へ遷移することがあります。正確な動作はデバイスの実装に依存します。

ノートパソコンでバッテリー寿命を最大化するには、 GetDevicePowerState を使用して消費電力を抑えてください。たとえば、ディスクが現在パワーダウンしている場合、そのディスクにアクセスするとスピンアップが発生し、消費電力が増加してバッテリー寿命が短くなります。

システムがバッテリー電源で動作している間は、可能な限りデバイスへのアクセスを遅延または制限する必要があります。システムがバッテリー電源で動作しているかどうか、およびバッテリーの残量を判別するには、 GetSystemPowerStatus 関数を使用してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL GetDevicePowerState(
    HANDLE hDevice,
    BOOL* pfOn
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool GetDevicePowerState(
    IntPtr hDevice,   // HANDLE
    out bool pfOn   // BOOL* out
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function GetDevicePowerState(
    hDevice As IntPtr,   ' HANDLE
    <Out> ByRef pfOn As Boolean   ' BOOL* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hDevice : HANDLE
' pfOn : BOOL* out
Declare PtrSafe Function GetDevicePowerState Lib "kernel32" ( _
    ByVal hDevice As LongPtr, _
    ByRef pfOn As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetDevicePowerState = ctypes.windll.kernel32.GetDevicePowerState
GetDevicePowerState.restype = wintypes.BOOL
GetDevicePowerState.argtypes = [
    wintypes.HANDLE,  # hDevice : HANDLE
    ctypes.c_void_p,  # pfOn : BOOL* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetDevicePowerState = Fiddle::Function.new(
  lib['GetDevicePowerState'],
  [
    Fiddle::TYPE_VOIDP,  # hDevice : HANDLE
    Fiddle::TYPE_VOIDP,  # pfOn : BOOL* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetDevicePowerState(
        hDevice: *mut core::ffi::c_void,  // HANDLE
        pfOn: *mut i32  // BOOL* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool GetDevicePowerState(IntPtr hDevice, out bool pfOn);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetDevicePowerState' -Namespace Win32 -PassThru
# $api::GetDevicePowerState(hDevice, pfOn)

#uselib "KERNEL32.dll"
#func global GetDevicePowerState "GetDevicePowerState" sptr, sptr
; GetDevicePowerState hDevice, varptr(pfOn)   ; 戻り値は stat
; hDevice : HANDLE -> "sptr"
; pfOn : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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