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

PowerSettingRegisterNotification

関数
指定電源設定の変更通知の受信を登録する。
DLLPOWRPROF.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

WIN32_ERROR PowerSettingRegisterNotification(
    const GUID* SettingGuid,
    REGISTER_NOTIFICATION_FLAGS Flags,
    HANDLE Recipient,
    void** RegistrationHandle
);

パラメーター

名前方向説明
SettingGuidGUID*in電源設定を表す GUID です。
FlagsREGISTER_NOTIFICATION_FLAGSin

通知の受信者に関する情報です。このパラメーターには次のいずれかの値を指定できます。

意味
DEVICE_NOTIFY_SERVICE_HANDLE
Recipient パラメーターはサービスへのハンドルです。このハンドルを取得するには、CreateService または OpenService 関数を使用します。
DEVICE_NOTIFY_CALLBACK
Recipient パラメーターは、電源設定が変更されたときに呼び出すコールバック関数へのポインターです。この場合、RecipientPDEVICE_NOTIFY_SUBSCRIBE_PARAMETERS 型である必要があります。
RecipientHANDLEin通知の受信者へのハンドルです。
RegistrationHandlevoid**out登録へのハンドルです。通知の登録を解除するには、このハンドルを使用します。

戻り値の型: WIN32_ERROR

公式ドキュメント

電源設定が変更されたときに通知を受け取るための登録を行います。

戻り値

呼び出しが成功した場合は ERROR_SUCCESS (0) を返し、失敗した場合は 0 以外の値を返します。

解説(Remarks)

登録の直後に、コールバックは電源設定の現在の値で呼び出されます。電源設定の変更中に登録が行われた場合、複数回のコールバックを受け取ることがあります。最後のコールバックが最新の更新内容です。

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

各言語での呼び出し定義

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

WIN32_ERROR PowerSettingRegisterNotification(
    const GUID* SettingGuid,
    REGISTER_NOTIFICATION_FLAGS Flags,
    HANDLE Recipient,
    void** RegistrationHandle
);
[DllImport("POWRPROF.dll", ExactSpelling = true)]
static extern uint PowerSettingRegisterNotification(
    ref Guid SettingGuid,   // GUID*
    uint Flags,   // REGISTER_NOTIFICATION_FLAGS
    IntPtr Recipient,   // HANDLE
    IntPtr RegistrationHandle   // void** out
);
<DllImport("POWRPROF.dll", ExactSpelling:=True)>
Public Shared Function PowerSettingRegisterNotification(
    ByRef SettingGuid As Guid,   ' GUID*
    Flags As UInteger,   ' REGISTER_NOTIFICATION_FLAGS
    Recipient As IntPtr,   ' HANDLE
    RegistrationHandle As IntPtr   ' void** out
) As UInteger
End Function
' SettingGuid : GUID*
' Flags : REGISTER_NOTIFICATION_FLAGS
' Recipient : HANDLE
' RegistrationHandle : void** out
Declare PtrSafe Function PowerSettingRegisterNotification Lib "powrprof" ( _
    ByVal SettingGuid As LongPtr, _
    ByVal Flags As Long, _
    ByVal Recipient As LongPtr, _
    ByVal RegistrationHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PowerSettingRegisterNotification = ctypes.windll.powrprof.PowerSettingRegisterNotification
PowerSettingRegisterNotification.restype = wintypes.DWORD
PowerSettingRegisterNotification.argtypes = [
    ctypes.c_void_p,  # SettingGuid : GUID*
    wintypes.DWORD,  # Flags : REGISTER_NOTIFICATION_FLAGS
    wintypes.HANDLE,  # Recipient : HANDLE
    ctypes.c_void_p,  # RegistrationHandle : void** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('POWRPROF.dll')
PowerSettingRegisterNotification = Fiddle::Function.new(
  lib['PowerSettingRegisterNotification'],
  [
    Fiddle::TYPE_VOIDP,  # SettingGuid : GUID*
    -Fiddle::TYPE_INT,  # Flags : REGISTER_NOTIFICATION_FLAGS
    Fiddle::TYPE_VOIDP,  # Recipient : HANDLE
    Fiddle::TYPE_VOIDP,  # RegistrationHandle : void** out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "powrprof")]
extern "system" {
    fn PowerSettingRegisterNotification(
        SettingGuid: *const GUID,  // GUID*
        Flags: u32,  // REGISTER_NOTIFICATION_FLAGS
        Recipient: *mut core::ffi::c_void,  // HANDLE
        RegistrationHandle: *mut *mut ()  // void** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("POWRPROF.dll")]
public static extern uint PowerSettingRegisterNotification(ref Guid SettingGuid, uint Flags, IntPtr Recipient, IntPtr RegistrationHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_PowerSettingRegisterNotification' -Namespace Win32 -PassThru
# $api::PowerSettingRegisterNotification(SettingGuid, Flags, Recipient, RegistrationHandle)
#uselib "POWRPROF.dll"
#func global PowerSettingRegisterNotification "PowerSettingRegisterNotification" sptr, sptr, sptr, sptr
; PowerSettingRegisterNotification varptr(SettingGuid), Flags, Recipient, RegistrationHandle   ; 戻り値は stat
; SettingGuid : GUID* -> "sptr"
; Flags : REGISTER_NOTIFICATION_FLAGS -> "sptr"
; Recipient : HANDLE -> "sptr"
; RegistrationHandle : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "POWRPROF.dll"
#cfunc global PowerSettingRegisterNotification "PowerSettingRegisterNotification" var, int, sptr, sptr
; res = PowerSettingRegisterNotification(SettingGuid, Flags, Recipient, RegistrationHandle)
; SettingGuid : GUID* -> "var"
; Flags : REGISTER_NOTIFICATION_FLAGS -> "int"
; Recipient : HANDLE -> "sptr"
; RegistrationHandle : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR PowerSettingRegisterNotification(GUID* SettingGuid, REGISTER_NOTIFICATION_FLAGS Flags, HANDLE Recipient, void** RegistrationHandle)
#uselib "POWRPROF.dll"
#cfunc global PowerSettingRegisterNotification "PowerSettingRegisterNotification" var, int, intptr, intptr
; res = PowerSettingRegisterNotification(SettingGuid, Flags, Recipient, RegistrationHandle)
; SettingGuid : GUID* -> "var"
; Flags : REGISTER_NOTIFICATION_FLAGS -> "int"
; Recipient : HANDLE -> "intptr"
; RegistrationHandle : void** out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
	procPowerSettingRegisterNotification = powrprof.NewProc("PowerSettingRegisterNotification")
)

// SettingGuid (GUID*), Flags (REGISTER_NOTIFICATION_FLAGS), Recipient (HANDLE), RegistrationHandle (void** out)
r1, _, err := procPowerSettingRegisterNotification.Call(
	uintptr(SettingGuid),
	uintptr(Flags),
	uintptr(Recipient),
	uintptr(RegistrationHandle),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function PowerSettingRegisterNotification(
  SettingGuid: PGUID;   // GUID*
  Flags: DWORD;   // REGISTER_NOTIFICATION_FLAGS
  Recipient: THandle;   // HANDLE
  RegistrationHandle: Pointer   // void** out
): DWORD; stdcall;
  external 'POWRPROF.dll' name 'PowerSettingRegisterNotification';
result := DllCall("POWRPROF\PowerSettingRegisterNotification"
    , "Ptr", SettingGuid   ; GUID*
    , "UInt", Flags   ; REGISTER_NOTIFICATION_FLAGS
    , "Ptr", Recipient   ; HANDLE
    , "Ptr", RegistrationHandle   ; void** out
    , "UInt")   ; return: WIN32_ERROR
●PowerSettingRegisterNotification(SettingGuid, Flags, Recipient, RegistrationHandle) = DLL("POWRPROF.dll", "dword PowerSettingRegisterNotification(void*, dword, void*, void*)")
# 呼び出し: PowerSettingRegisterNotification(SettingGuid, Flags, Recipient, RegistrationHandle)
# SettingGuid : GUID* -> "void*"
# Flags : REGISTER_NOTIFICATION_FLAGS -> "dword"
# Recipient : HANDLE -> "void*"
# RegistrationHandle : void** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef PowerSettingRegisterNotificationNative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Void>, Pointer<Void>);
typedef PowerSettingRegisterNotificationDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Void>);
final PowerSettingRegisterNotification = DynamicLibrary.open('POWRPROF.dll')
    .lookupFunction<PowerSettingRegisterNotificationNative, PowerSettingRegisterNotificationDart>('PowerSettingRegisterNotification');
// SettingGuid : GUID* -> Pointer<Void>
// Flags : REGISTER_NOTIFICATION_FLAGS -> Uint32
// Recipient : HANDLE -> Pointer<Void>
// RegistrationHandle : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PowerSettingRegisterNotification(
  SettingGuid: PGUID;   // GUID*
  Flags: DWORD;   // REGISTER_NOTIFICATION_FLAGS
  Recipient: THandle;   // HANDLE
  RegistrationHandle: Pointer   // void** out
): DWORD; stdcall;
  external 'POWRPROF.dll' name 'PowerSettingRegisterNotification';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PowerSettingRegisterNotification"
  c_PowerSettingRegisterNotification :: Ptr () -> Word32 -> Ptr () -> Ptr () -> IO Word32
-- SettingGuid : GUID* -> Ptr ()
-- Flags : REGISTER_NOTIFICATION_FLAGS -> Word32
-- Recipient : HANDLE -> Ptr ()
-- RegistrationHandle : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let powersettingregisternotification =
  foreign "PowerSettingRegisterNotification"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* SettingGuid : GUID* -> (ptr void) *)
(* Flags : REGISTER_NOTIFICATION_FLAGS -> uint32_t *)
(* Recipient : HANDLE -> (ptr void) *)
(* RegistrationHandle : void** 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 ("PowerSettingRegisterNotification" power-setting-register-notification :convention :stdcall) :uint32
  (setting-guid :pointer)   ; GUID*
  (flags :uint32)   ; REGISTER_NOTIFICATION_FLAGS
  (recipient :pointer)   ; HANDLE
  (registration-handle :pointer))   ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PowerSettingRegisterNotification = Win32::API::More->new('POWRPROF',
    'DWORD PowerSettingRegisterNotification(LPVOID SettingGuid, DWORD Flags, HANDLE Recipient, LPVOID RegistrationHandle)');
# my $ret = $PowerSettingRegisterNotification->Call($SettingGuid, $Flags, $Recipient, $RegistrationHandle);
# SettingGuid : GUID* -> LPVOID
# Flags : REGISTER_NOTIFICATION_FLAGS -> DWORD
# Recipient : HANDLE -> HANDLE
# RegistrationHandle : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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