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

UmsThreadYield

関数
現在のUMSワーカースレッドの実行をスケジューラに譲る。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 7 以降

シグネチャ

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

BOOL UmsThreadYield(
    void* SchedulerParam
);

パラメーター

名前方向説明
SchedulerParamvoid*inスケジューラースレッドの UmsSchedulerProc 関数に渡すパラメーターです。

戻り値の型: BOOL

公式ドキュメント

呼び出し元の UMS ワーカースレッドが実行されているユーザーモードスケジューリング (UMS) スケジューラースレッドに制御を譲ります。

戻り値

関数が成功した場合は、0 以外の値を返します。

関数が失敗した場合は、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

UMS ワーカースレッドは、そのワーカースレッドが実行されている UMS スケジューラースレッドに協調的に制御を譲るために UmsThreadYield 関数を呼び出します。UMS ワーカースレッドが UmsThreadYield を一度も呼び出さない場合、そのワーカースレッドはブロックされるか終了されるまで実行を続けます。

制御が UMS スケジューラースレッドに切り替わると、システムは関連付けられたスケジューラーのエントリポイント関数を、理由 UmsSchedulerThreadYield と、ワーカースレッドが UmsThreadYield の呼び出しで指定した ScheduleParam パラメーターとともに呼び出します。

ワーカースレッドの再スケジュールは、アプリケーションのスケジューラーの責任です。

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

各言語での呼び出し定義

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

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

UmsThreadYield = ctypes.windll.kernel32.UmsThreadYield
UmsThreadYield.restype = wintypes.BOOL
UmsThreadYield.argtypes = [
    ctypes.POINTER(None),  # SchedulerParam : void*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
UmsThreadYield = Fiddle::Function.new(
  lib['UmsThreadYield'],
  [
    Fiddle::TYPE_VOIDP,  # SchedulerParam : void*
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn UmsThreadYield(
        SchedulerParam: *mut ()  // void*
    ) -> 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 UmsThreadYield(IntPtr SchedulerParam);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_UmsThreadYield' -Namespace Win32 -PassThru
# $api::UmsThreadYield(SchedulerParam)
#uselib "KERNEL32.dll"
#func global UmsThreadYield "UmsThreadYield" sptr
; UmsThreadYield SchedulerParam   ; 戻り値は stat
; SchedulerParam : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global UmsThreadYield "UmsThreadYield" sptr
; res = UmsThreadYield(SchedulerParam)
; SchedulerParam : void* -> "sptr"
; BOOL UmsThreadYield(void* SchedulerParam)
#uselib "KERNEL32.dll"
#cfunc global UmsThreadYield "UmsThreadYield" intptr
; res = UmsThreadYield(SchedulerParam)
; SchedulerParam : void* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procUmsThreadYield = kernel32.NewProc("UmsThreadYield")
)

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

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

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

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

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

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