ホーム › System.Power › RegisterPowerSettingNotification

RegisterPowerSettingNotification

関数

指定電源設定の変更通知を受け取るよう登録する。

DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

HPOWERNOTIFY RegisterPowerSettingNotification(
    HANDLE hRecipient,
    const GUID* PowerSettingGuid,
    REGISTER_NOTIFICATION_FLAGS Flags
);

パラメーター

名前

型

方向

説明

hRecipient

HANDLE

電源設定通知の送信先を示すハンドルです。対話型アプリケーションの場合、Flags パラメーターは 0 にし、hRecipient パラメーターはウィンドウハンドルにします。サービスの場合、Flags パラメーターは 1 にし、hRecipient パラメーターは RegisterServiceCtrlHandlerEx から返される SERVICE_STATUS_HANDLE にします。

PowerSettingGuid

GUID*

通知を送信する対象の電源設定の GUID です。詳細については Registering for Power Events を参照してください。

Flags

REGISTER_NOTIFICATION_FLAGS

値	意味
DEVICE_NOTIFY_WINDOW_HANDLE 0	通知は、wParam パラメーターが PBT_POWERSETTINGCHANGE である WM_POWERBROADCAST メッセージを使用して送信されます。
DEVICE_NOTIFY_SERVICE_HANDLE 1	通知は、dwControl パラメーターが SERVICE_CONTROL_POWEREVENT、dwEventType が PBT_POWERSETTINGCHANGE である HandlerEx コールバック関数に送信されます。

戻り値の型: HPOWERNOTIFY

公式ドキュメント

特定の電源設定イベントに関する電源設定通知を受け取るようアプリケーションを登録します。

戻り値

電源通知の登録を解除するための通知ハンドルを返します。関数が失敗した場合、戻り値は NULL です。拡張エラー情報を取得するには、GetLastError を呼び出してください。

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

各言語での呼び出し定義

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

HPOWERNOTIFY RegisterPowerSettingNotification(
    HANDLE hRecipient,
    const GUID* PowerSettingGuid,
    REGISTER_NOTIFICATION_FLAGS Flags
);

[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr RegisterPowerSettingNotification(
    IntPtr hRecipient,   // HANDLE
    ref Guid PowerSettingGuid,   // GUID*
    uint Flags   // REGISTER_NOTIFICATION_FLAGS
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RegisterPowerSettingNotification(
    hRecipient As IntPtr,   ' HANDLE
    ByRef PowerSettingGuid As Guid,   ' GUID*
    Flags As UInteger   ' REGISTER_NOTIFICATION_FLAGS
) As IntPtr
End Function

' hRecipient : HANDLE
' PowerSettingGuid : GUID*
' Flags : REGISTER_NOTIFICATION_FLAGS
Declare PtrSafe Function RegisterPowerSettingNotification Lib "user32" ( _
    ByVal hRecipient As LongPtr, _
    ByVal PowerSettingGuid As LongPtr, _
    ByVal Flags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegisterPowerSettingNotification = ctypes.windll.user32.RegisterPowerSettingNotification
RegisterPowerSettingNotification.restype = ctypes.c_ssize_t
RegisterPowerSettingNotification.argtypes = [
    wintypes.HANDLE,  # hRecipient : HANDLE
    ctypes.c_void_p,  # PowerSettingGuid : GUID*
    wintypes.DWORD,  # Flags : REGISTER_NOTIFICATION_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
RegisterPowerSettingNotification = Fiddle::Function.new(
  lib['RegisterPowerSettingNotification'],
  [
    Fiddle::TYPE_VOIDP,  # hRecipient : HANDLE
    Fiddle::TYPE_VOIDP,  # PowerSettingGuid : GUID*
    -Fiddle::TYPE_INT,  # Flags : REGISTER_NOTIFICATION_FLAGS
  ],
  Fiddle::TYPE_INTPTR_T)

#[link(name = "user32")]
extern "system" {
    fn RegisterPowerSettingNotification(
        hRecipient: *mut core::ffi::c_void,  // HANDLE
        PowerSettingGuid: *const GUID,  // GUID*
        Flags: u32  // REGISTER_NOTIFICATION_FLAGS
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", SetLastError = true)]
public static extern IntPtr RegisterPowerSettingNotification(IntPtr hRecipient, ref Guid PowerSettingGuid, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_RegisterPowerSettingNotification' -Namespace Win32 -PassThru
# $api::RegisterPowerSettingNotification(hRecipient, PowerSettingGuid, Flags)

#uselib "USER32.dll"
#func global RegisterPowerSettingNotification "RegisterPowerSettingNotification" sptr, sptr, sptr
; RegisterPowerSettingNotification hRecipient, varptr(PowerSettingGuid), Flags   ; 戻り値は stat
; hRecipient : HANDLE -> "sptr"
; PowerSettingGuid : GUID* -> "sptr"
; Flags : REGISTER_NOTIFICATION_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global RegisterPowerSettingNotification "RegisterPowerSettingNotification" sptr, var, int
; res = RegisterPowerSettingNotification(hRecipient, PowerSettingGuid, Flags)
; hRecipient : HANDLE -> "sptr"
; PowerSettingGuid : GUID* -> "var"
; Flags : REGISTER_NOTIFICATION_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global RegisterPowerSettingNotification "RegisterPowerSettingNotification" sptr, sptr, int
; res = RegisterPowerSettingNotification(hRecipient, varptr(PowerSettingGuid), Flags)
; hRecipient : HANDLE -> "sptr"
; PowerSettingGuid : GUID* -> "sptr"
; Flags : REGISTER_NOTIFICATION_FLAGS -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。