PowerSetRequest

関数

指定種別の電源要求を有効化しスリープ等を抑止する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 7 以降

シグネチャ

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

BOOL PowerSetRequest(
    HANDLE PowerRequest,
    POWER_REQUEST_TYPE RequestType
);

パラメーター

名前

型

方向

説明

PowerRequest

HANDLE

電源要求オブジェクトへのハンドル。

RequestType

POWER_REQUEST_TYPE

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

値	説明
PowerRequestDisplayRequired	長時間ユーザー入力がない場合でも、ディスプレイをオンのままにします。注: ディスプレイをオンのままにし、要求が継続する間システムがスリープに入らないようにするには、PowerRequestDisplayRequired に加えて PowerRequestSystemRequired も取得する必要があります。
PowerRequestSystemRequired	ユーザーが一定期間操作していなくても、スリープに入らずシステムの動作を継続します。
PowerRequestAwayModeRequired	ユーザーの明示的な操作に応じて、システムがスリープではなく不在モードに入ります。不在モードでは、システムは動作を継続しますが、オーディオとビデオをオフにしてスリープしているように見せます。PowerRequestAwayModeRequired は従来のスリープ (S3) システムでのみ適用されます。
PowerRequestExecutionRequired	プロセス寿命管理機構による中断や終了の対象とならず、呼び出し元のプロセスの実行を継続します。プロセスの実行が許可される時期と時間は、オペレーティングシステムおよび電源ポリシー設定に依存します。従来のスリープ (S3) システムでは、有効な PowerRequestExecutionRequired 要求は PowerRequestSystemRequired を含意します。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功すると、0 以外の値を返します。

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

解説(Remarks)

DC 電源で動作するモダンスタンバイシステムでは、システム要求および実行要求の電源要求は、システムスリープのタイムアウトが経過してから 5 分後に終了します。

従来のスリープ (S3) システムにおける PowerRequestAwayModeRequired を除き、電源要求はユーザーが開始したシステムのスリープ移行 (電源ボタン、ふたを閉じる、または スタート メニューから スリープ を選択) によって終了します。

電力を節約し、最良のユーザー体験を提供するため、電源要求を使用するアプリケーションは次のベストプラクティスに従う必要があります。

電源要求を作成する際は、REASON_CONTEXT 構造体に、要求の理由を説明するローカライズされたテキスト文字列を指定します。
要求を必要とするシナリオの直前に PowerSetRequest を呼び出します。
シナリオが終了したらすぐに PowerClearRequest を呼び出して、要求の参照カウントをデクリメントします。
プロセスが終了する前、またはサービスが停止する前に、すべての要求オブジェクトと関連するハンドルをクリーンアップします。

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

各言語での呼び出し定義

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

BOOL PowerSetRequest(
    HANDLE PowerRequest,
    POWER_REQUEST_TYPE RequestType
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool PowerSetRequest(
    IntPtr PowerRequest,   // HANDLE
    int RequestType   // POWER_REQUEST_TYPE
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PowerSetRequest(
    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 PowerSetRequest 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

PowerSetRequest = ctypes.windll.kernel32.PowerSetRequest
PowerSetRequest.restype = wintypes.BOOL
PowerSetRequest.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')
PowerSetRequest = Fiddle::Function.new(
  lib['PowerSetRequest'],
  [
    Fiddle::TYPE_VOIDP,  # PowerRequest : HANDLE
    Fiddle::TYPE_INT,  # RequestType : POWER_REQUEST_TYPE
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn PowerSetRequest(
        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 PowerSetRequest(IntPtr PowerRequest, int RequestType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_PowerSetRequest' -Namespace Win32 -PassThru
# $api::PowerSetRequest(PowerRequest, RequestType)

#uselib "KERNEL32.dll"
#func global PowerSetRequest "PowerSetRequest" sptr, sptr
; PowerSetRequest PowerRequest, RequestType   ; 戻り値は stat
; PowerRequest : HANDLE -> "sptr"
; RequestType : POWER_REQUEST_TYPE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "KERNEL32.dll"
#cfunc global PowerSetRequest "PowerSetRequest" sptr, int
; res = PowerSetRequest(PowerRequest, RequestType)
; PowerRequest : HANDLE -> "sptr"
; RequestType : POWER_REQUEST_TYPE -> "int"

; BOOL PowerSetRequest(HANDLE PowerRequest, POWER_REQUEST_TYPE RequestType)
#uselib "KERNEL32.dll"
#cfunc global PowerSetRequest "PowerSetRequest" intptr, int
; res = PowerSetRequest(PowerRequest, RequestType)
; PowerRequest : HANDLE -> "intptr"
; RequestType : POWER_REQUEST_TYPE -> "int"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procPowerSetRequest = kernel32.NewProc("PowerSetRequest")
)

// PowerRequest (HANDLE), RequestType (POWER_REQUEST_TYPE)
r1, _, err := procPowerSetRequest.Call(
	uintptr(PowerRequest),
	uintptr(RequestType),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function PowerSetRequest(
  PowerRequest: THandle;   // HANDLE
  RequestType: Integer   // POWER_REQUEST_TYPE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'PowerSetRequest';

result := DllCall("KERNEL32\PowerSetRequest"
    , "Ptr", PowerRequest   ; HANDLE
    , "Int", RequestType   ; POWER_REQUEST_TYPE
    , "Int")   ; return: BOOL

●PowerSetRequest(PowerRequest, RequestType) = DLL("KERNEL32.dll", "bool PowerSetRequest(void*, int)")
# 呼び出し: PowerSetRequest(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 PowerSetRequest(
    PowerRequest: ?*anyopaque, // HANDLE
    RequestType: i32 // POWER_REQUEST_TYPE
) callconv(std.os.windows.WINAPI) i32;

proc PowerSetRequest(
    PowerRequest: pointer,  # HANDLE
    RequestType: int32  # POWER_REQUEST_TYPE
): int32 {.importc: "PowerSetRequest", stdcall, dynlib: "KERNEL32.dll".}

pragma(lib, "kernel32");
extern(Windows)
int PowerSetRequest(
    void* PowerRequest,   // HANDLE
    int RequestType   // POWER_REQUEST_TYPE
);

ccall((:PowerSetRequest, "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 PowerSetRequest(
    void* PowerRequest,
    int32_t RequestType);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.PowerSetRequest(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 PowerSetRequest = lib.func('__stdcall', 'PowerSetRequest', 'int32_t', ['void *', 'int32_t']);
// PowerSetRequest(PowerRequest, RequestType)
// PowerRequest : HANDLE -> 'void *'
// RequestType : POWER_REQUEST_TYPE -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("KERNEL32.dll", {
  PowerSetRequest: { parameters: ["pointer", "i32"], result: "i32" },
});
// lib.symbols.PowerSetRequest(PowerRequest, RequestType)
// PowerRequest : HANDLE -> "pointer"
// RequestType : POWER_REQUEST_TYPE -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t PowerSetRequest(
    void* PowerRequest,
    int32_t RequestType);
C, "KERNEL32.dll");
// $ffi->PowerSetRequest(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 PowerSetRequest(
        Pointer PowerRequest,   // HANDLE
        int RequestType   // POWER_REQUEST_TYPE
    );
}

@[Link("kernel32")]
lib LibKERNEL32
  fun PowerSetRequest = PowerSetRequest(
    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 PowerSetRequestNative = Int32 Function(Pointer<Void>, Int32);
typedef PowerSetRequestDart = int Function(Pointer<Void>, int);
final PowerSetRequest = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<PowerSetRequestNative, PowerSetRequestDart>('PowerSetRequest');
// PowerRequest : HANDLE -> Pointer<Void>
// RequestType : POWER_REQUEST_TYPE -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function PowerSetRequest(
  PowerRequest: THandle;   // HANDLE
  RequestType: Integer   // POWER_REQUEST_TYPE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'PowerSetRequest';

import Foreign
import Foreign.C.Types
import Foreign.C.String

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

open Ctypes
open Foreign

let powersetrequest =
  foreign "PowerSetRequest"
    ((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 ("PowerSetRequest" power-set-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 $PowerSetRequest = Win32::API::More->new('KERNEL32',
    'BOOL PowerSetRequest(HANDLE PowerRequest, int RequestType)');
# my $ret = $PowerSetRequest->Call($PowerRequest, $RequestType);
# PowerRequest : HANDLE -> HANDLE
# RequestType : POWER_REQUEST_TYPE -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。