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

PowerClearRequest

関数
指定種別の電源要求を解除する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 7 以降

シグネチャ

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

BOOL PowerClearRequest(
    HANDLE PowerRequest,
    POWER_REQUEST_TYPE RequestType
);

パラメーター

名前方向説明
PowerRequestHANDLEin電源要求オブジェクトのハンドルです。
RequestTypePOWER_REQUEST_TYPEin

デクリメントする電源要求の種類です。このパラメーターには、次のいずれかの値を指定できます。

意味
PowerRequestDisplayRequired
ユーザー入力が長時間ない場合でも、ディスプレイがオンのまま維持されます。
PowerRequestSystemRequired
ユーザーの操作がない期間が続いても、システムはスリープに入らず実行を継続します。
PowerRequestAwayModeRequired
システムはスリープではなく away モードに入ります。away モードでは、システムは実行を継続しますが、スリープしているように見せるためにオーディオとビデオをオフにします。
PowerRequestExecutionRequired
呼び出し元プロセスは、プロセス ライフタイム管理の仕組みによって中断または終了されることなく、実行を継続します。プロセスの実行が許可されるタイミングと期間は、オペレーティング システムおよび電源ポリシーの設定によって異なります。

PowerRequestExecutionRequired 要求が有効な場合、それは PowerRequestSystemRequired を暗黙的に含みます。

PowerRequestExecutionRequired 要求の種類は、アプリケーションでのみ使用できます。サービスはこの要求の種類を使用できません。

Windows 7 および Windows Server 2008 R2: この要求の種類は、Windows 8 および Windows Server 2012 以降でサポートされます。

戻り値の型: BOOL

公式ドキュメント

電源要求オブジェクトに対して、指定された種類の電源要求のカウントをデクリメントします。

戻り値

関数が成功した場合は、0 以外の値を返します。

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

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

各言語での呼び出し定義

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

BOOL PowerClearRequest(
    HANDLE PowerRequest,
    POWER_REQUEST_TYPE RequestType
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool PowerClearRequest(
    IntPtr PowerRequest,   // HANDLE
    int RequestType   // POWER_REQUEST_TYPE
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PowerClearRequest(
    PowerRequest As IntPtr,   ' HANDLE
    RequestType As Integer   ' POWER_REQUEST_TYPE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' PowerRequest : HANDLE
' RequestType : POWER_REQUEST_TYPE
Declare PtrSafe Function PowerClearRequest Lib "kernel32" ( _
    ByVal PowerRequest As LongPtr, _
    ByVal RequestType As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PowerClearRequest = ctypes.windll.kernel32.PowerClearRequest
PowerClearRequest.restype = wintypes.BOOL
PowerClearRequest.argtypes = [
    wintypes.HANDLE,  # PowerRequest : HANDLE
    ctypes.c_int,  # RequestType : POWER_REQUEST_TYPE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
PowerClearRequest = Fiddle::Function.new(
  lib['PowerClearRequest'],
  [
    Fiddle::TYPE_VOIDP,  # PowerRequest : HANDLE
    Fiddle::TYPE_INT,  # RequestType : POWER_REQUEST_TYPE
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn PowerClearRequest(
        PowerRequest: *mut core::ffi::c_void,  // HANDLE
        RequestType: i32  // POWER_REQUEST_TYPE
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool PowerClearRequest(IntPtr PowerRequest, int RequestType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_PowerClearRequest' -Namespace Win32 -PassThru
# $api::PowerClearRequest(PowerRequest, RequestType)
#uselib "KERNEL32.dll"
#func global PowerClearRequest "PowerClearRequest" sptr, sptr
; PowerClearRequest PowerRequest, RequestType   ; 戻り値は stat
; PowerRequest : HANDLE -> "sptr"
; RequestType : POWER_REQUEST_TYPE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global PowerClearRequest "PowerClearRequest" sptr, int
; res = PowerClearRequest(PowerRequest, RequestType)
; PowerRequest : HANDLE -> "sptr"
; RequestType : POWER_REQUEST_TYPE -> "int"
; BOOL PowerClearRequest(HANDLE PowerRequest, POWER_REQUEST_TYPE RequestType)
#uselib "KERNEL32.dll"
#cfunc global PowerClearRequest "PowerClearRequest" intptr, int
; res = PowerClearRequest(PowerRequest, RequestType)
; PowerRequest : HANDLE -> "intptr"
; RequestType : POWER_REQUEST_TYPE -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procPowerClearRequest = kernel32.NewProc("PowerClearRequest")
)

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

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

typedef PowerClearRequestNative = Int32 Function(Pointer<Void>, Int32);
typedef PowerClearRequestDart = int Function(Pointer<Void>, int);
final PowerClearRequest = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<PowerClearRequestNative, PowerClearRequestDart>('PowerClearRequest');
// PowerRequest : HANDLE -> Pointer<Void>
// RequestType : POWER_REQUEST_TYPE -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PowerClearRequest(
  PowerRequest: THandle;   // HANDLE
  RequestType: Integer   // POWER_REQUEST_TYPE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'PowerClearRequest';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PowerClearRequest"
  c_PowerClearRequest :: Ptr () -> Int32 -> IO CInt
-- PowerRequest : HANDLE -> Ptr ()
-- RequestType : POWER_REQUEST_TYPE -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let powerclearrequest =
  foreign "PowerClearRequest"
    ((ptr void) @-> int32_t @-> returning int32_t)
(* PowerRequest : HANDLE -> (ptr void) *)
(* RequestType : POWER_REQUEST_TYPE -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("PowerClearRequest" power-clear-request :convention :stdcall) :int32
  (power-request :pointer)   ; HANDLE
  (request-type :int32))   ; POWER_REQUEST_TYPE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PowerClearRequest = Win32::API::More->new('KERNEL32',
    'BOOL PowerClearRequest(HANDLE PowerRequest, int RequestType)');
# my $ret = $PowerClearRequest->Call($PowerRequest, $RequestType);
# PowerRequest : HANDLE -> HANDLE
# RequestType : POWER_REQUEST_TYPE -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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