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

PowerUnregisterFromEffectivePowerModeNotifications

関数
実効電源モード通知の登録を解除する。
DLLPOWRPROF.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

HRESULT PowerUnregisterFromEffectivePowerModeNotifications(
    void* RegistrationHandle
);

パラメーター

名前方向説明
RegistrationHandlevoid*in単一の電力モード登録に対応するハンドルです。このハンドルは、PowerRegisterForEffectivePowerModeNotifications の呼び出し後に呼び出し元が保存しておき、ここで渡す必要があります。

戻り値の型: HRESULT

公式ドキュメント

実効電力モード(effective power mode)の変更通知の登録を解除します。この関数はクリーンアップ処理から呼び出されることを想定しており、登録を解除する前にすべてのコールバックが完了するまで待機します。

戻り値

呼び出しに成功した場合は S_OK(ゼロ)を返し、失敗した場合は非ゼロの値を返します。

解説(Remarks)

登録の直後に、コールバックが電力設定の現在の値とともに呼び出されます。電力設定が変化している最中に登録が行われた場合、複数のコールバックを受け取ることがあります。最後のコールバックが最新の更新を表します。

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

各言語での呼び出し定義

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

HRESULT PowerUnregisterFromEffectivePowerModeNotifications(
    void* RegistrationHandle
);
[DllImport("POWRPROF.dll", ExactSpelling = true)]
static extern int PowerUnregisterFromEffectivePowerModeNotifications(
    IntPtr RegistrationHandle   // void*
);
<DllImport("POWRPROF.dll", ExactSpelling:=True)>
Public Shared Function PowerUnregisterFromEffectivePowerModeNotifications(
    RegistrationHandle As IntPtr   ' void*
) As Integer
End Function
' RegistrationHandle : void*
Declare PtrSafe Function PowerUnregisterFromEffectivePowerModeNotifications Lib "powrprof" ( _
    ByVal RegistrationHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PowerUnregisterFromEffectivePowerModeNotifications = ctypes.windll.powrprof.PowerUnregisterFromEffectivePowerModeNotifications
PowerUnregisterFromEffectivePowerModeNotifications.restype = ctypes.c_int
PowerUnregisterFromEffectivePowerModeNotifications.argtypes = [
    ctypes.POINTER(None),  # RegistrationHandle : void*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('POWRPROF.dll')
PowerUnregisterFromEffectivePowerModeNotifications = Fiddle::Function.new(
  lib['PowerUnregisterFromEffectivePowerModeNotifications'],
  [
    Fiddle::TYPE_VOIDP,  # RegistrationHandle : void*
  ],
  Fiddle::TYPE_INT)
#[link(name = "powrprof")]
extern "system" {
    fn PowerUnregisterFromEffectivePowerModeNotifications(
        RegistrationHandle: *mut ()  // void*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("POWRPROF.dll")]
public static extern int PowerUnregisterFromEffectivePowerModeNotifications(IntPtr RegistrationHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'POWRPROF_PowerUnregisterFromEffectivePowerModeNotifications' -Namespace Win32 -PassThru
# $api::PowerUnregisterFromEffectivePowerModeNotifications(RegistrationHandle)
#uselib "POWRPROF.dll"
#func global PowerUnregisterFromEffectivePowerModeNotifications "PowerUnregisterFromEffectivePowerModeNotifications" sptr
; PowerUnregisterFromEffectivePowerModeNotifications RegistrationHandle   ; 戻り値は stat
; RegistrationHandle : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "POWRPROF.dll"
#cfunc global PowerUnregisterFromEffectivePowerModeNotifications "PowerUnregisterFromEffectivePowerModeNotifications" sptr
; res = PowerUnregisterFromEffectivePowerModeNotifications(RegistrationHandle)
; RegistrationHandle : void* -> "sptr"
; HRESULT PowerUnregisterFromEffectivePowerModeNotifications(void* RegistrationHandle)
#uselib "POWRPROF.dll"
#cfunc global PowerUnregisterFromEffectivePowerModeNotifications "PowerUnregisterFromEffectivePowerModeNotifications" intptr
; res = PowerUnregisterFromEffectivePowerModeNotifications(RegistrationHandle)
; RegistrationHandle : void* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	powrprof = windows.NewLazySystemDLL("POWRPROF.dll")
	procPowerUnregisterFromEffectivePowerModeNotifications = powrprof.NewProc("PowerUnregisterFromEffectivePowerModeNotifications")
)

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

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

typedef PowerUnregisterFromEffectivePowerModeNotificationsNative = Int32 Function(Pointer<Void>);
typedef PowerUnregisterFromEffectivePowerModeNotificationsDart = int Function(Pointer<Void>);
final PowerUnregisterFromEffectivePowerModeNotifications = DynamicLibrary.open('POWRPROF.dll')
    .lookupFunction<PowerUnregisterFromEffectivePowerModeNotificationsNative, PowerUnregisterFromEffectivePowerModeNotificationsDart>('PowerUnregisterFromEffectivePowerModeNotifications');
// RegistrationHandle : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PowerUnregisterFromEffectivePowerModeNotifications(
  RegistrationHandle: Pointer   // void*
): Integer; stdcall;
  external 'POWRPROF.dll' name 'PowerUnregisterFromEffectivePowerModeNotifications';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

(cffi:defcfun ("PowerUnregisterFromEffectivePowerModeNotifications" power-unregister-from-effective-power-mode-notifications :convention :stdcall) :int32
  (registration-handle :pointer))   ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PowerUnregisterFromEffectivePowerModeNotifications = Win32::API::More->new('POWRPROF',
    'int PowerUnregisterFromEffectivePowerModeNotifications(LPVOID RegistrationHandle)');
# my $ret = $PowerUnregisterFromEffectivePowerModeNotifications->Call($RegistrationHandle);
# RegistrationHandle : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。