ExecuteUmsThread
関数シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL ExecuteUmsThread(
void* UmsThread
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| UmsThread | void* | inout | 実行する対象のワーカースレッドの UMS スレッドコンテキストへのポインター。 |
戻り値の型: BOOL
公式ドキュメント
指定された UMS ワーカースレッドを実行します。
戻り値
関数が成功した場合、値は返されません。
関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。返される可能性のあるエラーコードには、以下のものがあります。
| 戻り値 | 説明 |
|---|---|
| 指定された UMS ワーカースレッドはシステムによって一時的にロックされています。呼び出し元は操作を再試行できます。 | |
| UMS はサポートされていません。 |
解説(Remarks)
ExecuteUmsThread 関数は、指定された UMS ワーカースレッドの状態を、呼び出し元の UMS スケジューラースレッドの状態の上に読み込み、ワーカースレッドが実行できるようにします。ワーカースレッドは、UmsThreadYield 関数を呼び出して制御を譲るか、ブロックされるか、または終了するまで実行を続けます。
ワーカースレッドが制御を譲るかブロックされると、システムはスケジューラースレッドの UmsSchedulerProc エントリポイント関数を呼び出します。以前にブロックされていたワーカースレッドのブロックが解除されると、システムは、そのワーカースレッドの作成時に UpdateProcThreadAttribute 関数で指定された完了リストにワーカースレッドをキューイングします。
ExecuteUmsThread 関数は、エラーが発生しない限り戻りません。関数が ERROR_RETRY を返した場合、そのエラーは一時的なものであり、操作を再試行できます。
関数が ERROR_RETRY 以外のエラーを返した場合、アプリケーションのスケジューラーは、QueryUmsThreadInformation をそれぞれ UmsThreadIsSuspended または UmsThreadIsTerminated で呼び出して、スレッドが中断または終了しているかどうかを確認する必要があります。その他に発生し得るエラーとしては、UMS スケジューラースレッドではないスレッドで関数を呼び出した場合、無効な UMS ワーカースレッドコンテキストを渡した場合、または別のスケジューラースレッドで既に実行中のワーカースレッドを指定した場合があります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
BOOL ExecuteUmsThread(
void* UmsThread
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ExecuteUmsThread(
IntPtr UmsThread // void* in/out
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ExecuteUmsThread(
UmsThread As IntPtr ' void* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' UmsThread : void* in/out
Declare PtrSafe Function ExecuteUmsThread Lib "kernel32" ( _
ByVal UmsThread As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
ExecuteUmsThread = ctypes.windll.kernel32.ExecuteUmsThread
ExecuteUmsThread.restype = wintypes.BOOL
ExecuteUmsThread.argtypes = [
ctypes.POINTER(None), # UmsThread : void* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
ExecuteUmsThread = Fiddle::Function.new(
lib['ExecuteUmsThread'],
[
Fiddle::TYPE_VOIDP, # UmsThread : void* in/out
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn ExecuteUmsThread(
UmsThread: *mut () // void* in/out
) -> 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 ExecuteUmsThread(IntPtr UmsThread);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ExecuteUmsThread' -Namespace Win32 -PassThru
# $api::ExecuteUmsThread(UmsThread)#uselib "KERNEL32.dll"
#func global ExecuteUmsThread "ExecuteUmsThread" sptr
; ExecuteUmsThread UmsThread ; 戻り値は stat
; UmsThread : void* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global ExecuteUmsThread "ExecuteUmsThread" sptr
; res = ExecuteUmsThread(UmsThread)
; UmsThread : void* in/out -> "sptr"; BOOL ExecuteUmsThread(void* UmsThread)
#uselib "KERNEL32.dll"
#cfunc global ExecuteUmsThread "ExecuteUmsThread" intptr
; res = ExecuteUmsThread(UmsThread)
; UmsThread : void* in/out -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procExecuteUmsThread = kernel32.NewProc("ExecuteUmsThread")
)
// UmsThread (void* in/out)
r1, _, err := procExecuteUmsThread.Call(
uintptr(UmsThread),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction ExecuteUmsThread(
UmsThread: Pointer // void* in/out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'ExecuteUmsThread';result := DllCall("KERNEL32\ExecuteUmsThread"
, "Ptr", UmsThread ; void* in/out
, "Int") ; return: BOOL●ExecuteUmsThread(UmsThread) = DLL("KERNEL32.dll", "bool ExecuteUmsThread(void*)")
# 呼び出し: ExecuteUmsThread(UmsThread)
# UmsThread : void* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn ExecuteUmsThread(
UmsThread: ?*anyopaque // void* in/out
) callconv(std.os.windows.WINAPI) i32;proc ExecuteUmsThread(
UmsThread: pointer # void* in/out
): int32 {.importc: "ExecuteUmsThread", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int ExecuteUmsThread(
void* UmsThread // void* in/out
);ccall((:ExecuteUmsThread, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid},),
UmsThread)
# UmsThread : void* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t ExecuteUmsThread(
void* UmsThread);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.ExecuteUmsThread(UmsThread)
-- UmsThread : void* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const ExecuteUmsThread = lib.func('__stdcall', 'ExecuteUmsThread', 'int32_t', ['void *']);
// ExecuteUmsThread(UmsThread)
// UmsThread : void* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
ExecuteUmsThread: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.ExecuteUmsThread(UmsThread)
// UmsThread : void* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t ExecuteUmsThread(
void* UmsThread);
C, "KERNEL32.dll");
// $ffi->ExecuteUmsThread(UmsThread);
// UmsThread : void* in/out
// 構造体/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 ExecuteUmsThread(
Pointer UmsThread // void* in/out
);
}@[Link("kernel32")]
lib LibKERNEL32
fun ExecuteUmsThread = ExecuteUmsThread(
UmsThread : Void* # void* in/out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef ExecuteUmsThreadNative = Int32 Function(Pointer<Void>);
typedef ExecuteUmsThreadDart = int Function(Pointer<Void>);
final ExecuteUmsThread = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<ExecuteUmsThreadNative, ExecuteUmsThreadDart>('ExecuteUmsThread');
// UmsThread : void* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function ExecuteUmsThread(
UmsThread: Pointer // void* in/out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'ExecuteUmsThread';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "ExecuteUmsThread"
c_ExecuteUmsThread :: Ptr () -> IO CInt
-- UmsThread : void* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let executeumsthread =
foreign "ExecuteUmsThread"
((ptr void) @-> returning int32_t)
(* UmsThread : void* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("ExecuteUmsThread" execute-ums-thread :convention :stdcall) :int32
(ums-thread :pointer)) ; void* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $ExecuteUmsThread = Win32::API::More->new('KERNEL32',
'BOOL ExecuteUmsThread(LPVOID UmsThread)');
# my $ret = $ExecuteUmsThread->Call($UmsThread);
# UmsThread : void* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f UmsThreadYield — 現在のUMSワーカースレッドの実行をスケジューラに譲る。
- f UpdateProcThreadAttribute — プロセス/スレッド属性リストに属性を設定する。