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

SwitchToThread

関数
実行可能な他のスレッドへCPUを明け渡す。
DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

BOOL SwitchToThread(void);

パラメーターなし。戻り値: BOOL

公式ドキュメント

呼び出し元スレッドが、現在のプロセッサ上で実行可能な別のスレッドに実行を譲るようにします。次に実行するスレッドはオペレーティングシステムが選択します。

戻り値

SwitchToThread 関数の呼び出しによってオペレーティングシステムが別のスレッドへ実行を切り替えた場合、戻り値は 0 以外になります。

実行可能な他のスレッドが存在しない場合、オペレーティングシステムは別のスレッドへ実行を切り替えず、戻り値は 0 になります。

解説(Remarks)

実行の譲渡は、呼び出し元スレッドのプロセッサ上で最大 1 回のスレッドスケジューリングのタイムスライスの間だけ有効です。オペレーティングシステムは、たとえ他のプロセッサがアイドル状態であっても、または優先度の低いスレッドを実行していても、別のプロセッサへ実行を切り替えることはありません。

譲渡したスレッドのタイムスライスが経過した後、オペレーティングシステムはそのスレッドの実行を再スケジュールします。再スケジュールは、譲渡したスレッドの優先度と、実行可能な他のスレッドの状態によって決定されます。

なお、オペレーティングシステムは、同時実行制御(concurrency control)によってのみ実行が妨げられているスレッドへは切り替えません。たとえば、I/O 完了ポートやスレッドプールは、実行可能な関連スレッドの数を制限します。すでに最大数のスレッドが実行されている場合、実行中のスレッドが終了するまで、追加の関連スレッドは実行できません。あるスレッドが SwitchToThread を使用して、これらの追加の関連スレッドのいずれかが処理を完了するのを待機する場合、プロセスがデッドロックに陥る可能性があります。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0400 以降として定義してください。詳細については、Using the Windows Headers を参照してください。

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

各言語での呼び出し定義

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

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

SwitchToThread = ctypes.windll.kernel32.SwitchToThread
SwitchToThread.restype = wintypes.BOOL
SwitchToThread.argtypes = []
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSwitchToThread = kernel32.NewProc("SwitchToThread")
)

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

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

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

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

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

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

関連項目

公式の関連項目