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

SleepEx

関数
指定時間スレッドを休止し警告可能な待機を行う。
DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD SleepEx(
    DWORD dwMilliseconds,
    BOOL bAlertable
);

パラメーター

名前方向説明
dwMillisecondsDWORDin

実行を中断する時間間隔(ミリ秒単位)。

値が 0 の場合、スレッドは実行可能状態にある他のスレッドにタイムスライスの残りを譲ります。実行可能な他のスレッドが存在しない場合、関数はただちに戻り、スレッドは実行を継続します。Windows XP: 値が 0 の場合、スレッドは実行可能状態にある同じ優先度の他のスレッドにタイムスライスの残りを譲ります。実行可能な同じ優先度のスレッドが存在しない場合、関数はただちに戻り、スレッドは実行を継続します。この動作は Windows Server 2003 以降で変更されました。

値が INFINITE の場合、中断はタイムアウトしないことを示します。

bAlertableBOOLin

このパラメーターが FALSE の場合、タイムアウト期間が経過するまで関数は戻りません。I/O 完了コールバックが発生しても、関数はただちには戻らず、I/O 完了関数は実行されません。APC がスレッドにキューイングされても、関数はただちには戻らず、APC 関数は実行されません。

このパラメーターが TRUE であり、かつこの関数を呼び出したスレッドが拡張 I/O 関数(ReadFileEx または WriteFileEx)を呼び出したスレッドと同一である場合、タイムアウト期間が経過したとき、または I/O 完了コールバック関数が発生したときに関数は戻ります。I/O 完了コールバックが発生した場合、I/O 完了関数が呼び出されます。APC がスレッドにキューイングされている場合(QueueUserAPC)、タイムアウト期間が経過したとき、または APC 関数が呼び出されたときに関数は戻ります。

戻り値の型: DWORD

公式ドキュメント

指定された条件が満たされるまで、現在のスレッドを中断します。

戻り値

指定された時間間隔が満了した場合、戻り値は 0 です。

1 つ以上の I/O 完了コールバック関数によって関数が戻った場合、戻り値は WAIT_IO_COMPLETION です。これは bAlertable が TRUE であり、かつ SleepEx 関数を呼び出したスレッドが拡張 I/O 関数を呼び出したスレッドと同一である場合にのみ発生します。

解説(Remarks)

この関数は、スレッドにタイムスライスの残りを譲らせ、dwMilliseconds の値に基づく期間だけ実行不可状態にします。スリープ間隔が経過すると、スレッドは実行可能状態になります。ただし、実行可能状態のスレッドがただちに実行されることは保証されない点に注意してください。したがって、スレッドはスリープ間隔の経過後の任意のタイミングまで実行されず、これはシステムの「ティック」周期や他のプロセスによる負荷係数に依存します。システムクロックは一定の周期で「ティック」します。スリープ間隔の精度を高めるには、timeGetDevCaps 関数を呼び出してサポートされる最小のタイマー分解能を確認し、timeBeginPeriod 関数を呼び出してタイマー分解能を最小値に設定します。timeBeginPeriod を呼び出す際は注意してください。頻繁に呼び出すと、システムクロック、システムの電力使用量、およびスケジューラに大きな影響を与える可能性があります。timeBeginPeriod を呼び出す場合は、アプリケーションの早い段階で 1 回だけ呼び出し、アプリケーションの最後で必ず timeEndPeriod 関数を呼び出してください。0 ミリ秒を指定した場合、スレッドはタイムスライスの残りを譲りますが、実行可能状態のままになります。詳細については、 Scheduling Priorities を参照してください。

この関数は、ReadFileEx または WriteFileEx 関数と組み合わせて、I/O 操作が完了するまでスレッドを中断するために使用できます。これらの関数は、I/O 操作が完了したときに実行される完了ルーチンを指定します。完了ルーチンが実行されるためには、完了コールバック関数が発生する時点で、I/O 関数を呼び出したスレッドがアラート可能な待機状態にある必要があります。スレッドは、 SleepExMsgWaitForMultipleObjectsExWaitForSingleObjectEx、または WaitForMultipleObjectsEx のいずれかを、関数の bAlertable パラメーターを TRUE に設定して呼び出すことで、アラート可能な待機状態に入ります。

次のシナリオでは、SleepEx の使用に注意してください。

これらのシナリオでは、 SleepEx ではなく MsgWaitForMultipleObjects または MsgWaitForMultipleObjectsEx を使用してください。

Windows Phone 8.1: この関数は、Windows Phone 8.1 以降の Windows Phone ストアアプリでサポートされています。

Windows 8.1 および Windows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストアアプリでサポートされています。

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

各言語での呼び出し定義

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

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

SleepEx = ctypes.windll.kernel32.SleepEx
SleepEx.restype = wintypes.DWORD
SleepEx.argtypes = [
    wintypes.DWORD,  # dwMilliseconds : DWORD
    wintypes.BOOL,  # bAlertable : BOOL
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSleepEx = kernel32.NewProc("SleepEx")
)

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

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

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

foreign import stdcall safe "SleepEx"
  c_SleepEx :: Word32 -> CInt -> IO Word32
-- dwMilliseconds : DWORD -> Word32
-- bAlertable : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("SleepEx" sleep-ex :convention :stdcall) :uint32
  (dw-milliseconds :uint32)   ; DWORD
  (b-alertable :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SleepEx = Win32::API::More->new('KERNEL32',
    'DWORD SleepEx(DWORD dwMilliseconds, BOOL bAlertable)');
# my $ret = $SleepEx->Call($dwMilliseconds, $bAlertable);
# dwMilliseconds : DWORD -> DWORD
# bAlertable : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目