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

RequestWakeupLatency

関数
システム復帰時の待機時間(レイテンシ)を要求する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

BOOL RequestWakeupLatency(
    LATENCY_TIME latency
);

パラメーター

名前方向説明
latencyLATENCY_TIMEin

コンピューターを復帰させるのにかかる時間に対するレイテンシ要件です。このパラメーターには、次の いずれかの値を指定できます。

意味
LT_LOWEST_LATENCY
1
PowerSystemSleeping1 状態 (ACPI 状態 S0 および APM 状態 Working に相当)。
LT_DONT_CARE
0
任意のレイテンシ (既定値)。

戻り値の型: BOOL

公式ドキュメント

効果はなく、STATUS_NOT_SUPPORTED を返します。この関数は、以前のバージョンの Windows との互換性のためにのみ提供されています。Windows Server 2008 および Windows Vista: 効果はなく、常に成功を返します。

戻り値

戻り値は 0 以外の値です。

解説(Remarks)

システムはスリープ状態を選択する際に、この復帰レイテンシ要件を使用します。復帰にかかる時間は特定のコンピューターのハードウェア設計によって決まるため、レイテンシは保証されません。

レイテンシ要求を取り消すには、 LT_DONT_CARE を指定して RequestWakeupLatency を呼び出します。

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

各言語での呼び出し定義

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

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

RequestWakeupLatency = ctypes.windll.kernel32.RequestWakeupLatency
RequestWakeupLatency.restype = wintypes.BOOL
RequestWakeupLatency.argtypes = [
    ctypes.c_int,  # latency : LATENCY_TIME
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procRequestWakeupLatency = kernel32.NewProc("RequestWakeupLatency")
)

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

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

typedef RequestWakeupLatencyNative = Int32 Function(Int32);
typedef RequestWakeupLatencyDart = int Function(int);
final RequestWakeupLatency = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<RequestWakeupLatencyNative, RequestWakeupLatencyDart>('RequestWakeupLatency');
// latency : LATENCY_TIME -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RequestWakeupLatency(
  latency: Integer   // LATENCY_TIME
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'RequestWakeupLatency';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RequestWakeupLatency"
  c_RequestWakeupLatency :: Int32 -> IO CInt
-- latency : LATENCY_TIME -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let requestwakeuplatency =
  foreign "RequestWakeupLatency"
    (int32_t @-> returning int32_t)
(* latency : LATENCY_TIME -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

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

関連項目

使用する型