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

Sleep

関数
指定したミリ秒数だけ現在のスレッドを休止する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

void Sleep(
    DWORD dwMilliseconds
);

パラメーター

名前方向説明
dwMillisecondsDWORDin

実行を中断する時間間隔をミリ秒単位で指定します。

0 を指定すると、スレッドはタイムスライスの残りを、実行可能な他の任意のスレッドに譲ります。実行可能な他のスレッドが存在しない場合、この関数は直ちに復帰し、スレッドは実行を継続します。Windows XP: 0 を指定すると、スレッドはタイムスライスの残りを、実行可能な同一優先度の他のスレッドに譲ります。実行可能な同一優先度の他のスレッドが存在しない場合、この関数は直ちに復帰し、スレッドは実行を継続します。この動作は Windows Server 2003 以降で変更されました。

INFINITE を指定すると、中断はタイムアウトしません。

戻り値の型: void

公式ドキュメント

タイムアウト間隔が経過するまで、現在のスレッドの実行を中断します。

解説(Remarks)

この関数は、スレッドにタイムスライスの残りを譲らせ、dwMilliseconds の値に基づく間隔の間、実行不可能な状態にします。システムクロックは一定の速度で「ティック」します。dwMilliseconds がシステムクロックの分解能より小さい場合、スレッドは指定した時間より短くスリープする可能性があります。dwMilliseconds が 1 ティックより大きく 2 ティックより小さい場合、待機時間は 1 ティックから 2 ティックの間のいずれかになり、以降も同様です。スリープ間隔の精度を高めるには、timeGetDevCaps 関数を呼び出してサポートされている最小タイマー分解能を調べ、timeBeginPeriod 関数を呼び出してタイマー分解能を最小値に設定します。timeBeginPeriod の呼び出しには注意してください。頻繁に呼び出すと、システムクロック、システムの消費電力、およびスケジューラに大きな影響を与える可能性があります。timeBeginPeriod を呼び出す場合は、アプリケーションの早い段階で 1 回だけ呼び出し、アプリケーションの最後に必ず timeEndPeriod 関数を呼び出すようにしてください。

スリープ間隔が経過すると、スレッドは実行可能な状態になります。0 ミリ秒を指定した場合、スレッドはタイムスライスの残りを譲りますが、実行可能な状態のままになります。実行可能なスレッドが直ちに実行される保証はないことに注意してください。そのため、スリープ間隔が経過してから実際に実行されるまでに、ある程度の時間がかかる場合があります。詳細については、 Scheduling Priorities を参照してください。

次のシナリオで Sleep を使用する場合は注意してください。

これらのシナリオでは、Sleep ではなく 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 ストアアプリでサポートされています。

例については、 Using Thread Local Storage を参照してください。

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

各言語での呼び出し定義

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

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

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

lib = Fiddle.dlopen('KERNEL32.dll')
Sleep = Fiddle::Function.new(
  lib['Sleep'],
  [
    -Fiddle::TYPE_INT,  # dwMilliseconds : DWORD
  ],
  Fiddle::TYPE_VOID)
#[link(name = "kernel32")]
extern "system" {
    fn Sleep(
        dwMilliseconds: u32  // DWORD
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern void Sleep(uint dwMilliseconds);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_Sleep' -Namespace Win32 -PassThru
# $api::Sleep(dwMilliseconds)
#uselib "KERNEL32.dll"
#func global Sleep "Sleep" sptr
; Sleep dwMilliseconds
; dwMilliseconds : DWORD -> "sptr"
#uselib "KERNEL32.dll"
#func global Sleep "Sleep" int
; Sleep dwMilliseconds
; dwMilliseconds : DWORD -> "int"
; void Sleep(DWORD dwMilliseconds)
#uselib "KERNEL32.dll"
#func global Sleep "Sleep" int
; Sleep dwMilliseconds
; dwMilliseconds : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSleep = kernel32.NewProc("Sleep")
)

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

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

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

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

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

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

関連項目

類似 API
公式の関連項目