ホーム › System.Threading › SetUmsThreadInformation

SetUmsThreadInformation

関数

指定のUMSスレッドに情報を設定する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 7 以降

シグネチャ

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

BOOL SetUmsThreadInformation(
    void* UmsThread,
    UMS_THREAD_INFO_CLASS UmsThreadInfoClass,
    void* UmsThreadInformation,
    DWORD UmsThreadInformationLength
);

パラメーター

名前	型	方向	説明
UmsThread	void*	in	UMS スレッドコンテキストへのポインター。
UmsThreadInfoClass	UMS_THREAD_INFO_CLASS	in	設定する情報の種類を指定する UMS_THREAD_INFO_CLASS 値。このパラメーターは UmsThreadUserContext である必要があります。
UmsThreadInformation	void*	in	設定する情報を格納したバッファーへのポインター。
UmsThreadInformationLength	DWORD	in	UmsThreadInformation バッファーのサイズ (バイト単位)。

戻り値の型: BOOL

公式ドキュメント

指定したユーザーモードスケジューリング (UMS) ワーカースレッドに、アプリケーション固有のコンテキスト情報を設定します。

戻り値

関数が成功すると、0 以外の値を返します。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。考えられるエラー値には次のものがあります。

戻り値	説明
ERROR_INFO_LENGTH_MISMATCH	バッファーサイズが、指定した情報クラスに必要なサイズと一致しません。
ERROR_INVALID_INFO_CLASS	UmsThreadInfoClass パラメーターが、サポートされていない情報クラスを指定しています。
ERROR_NOT_SUPPORTED	UMS はサポートされていません。

解説(Remarks)

SetUmsThreadInformation 関数は、指定した UMS ワーカースレッドに対して、アプリケーション定義のコンテキストを設定するために使用できます。コンテキスト情報には、スケジューラーごとやワーカースレッドごとの状態など、アプリケーションが追跡しておくと便利な任意の情報を含めることができます。UMS ワーカースレッドの基盤となる構造体はシステムによって管理されており、直接変更すべきではありません。

QueryUmsThreadInformation 関数を使用すると、指定したスレッドについて公開されているその他の情報 (スレッド実行ブロック (TEB) や、スレッドが中断または終了されているかどうかなど) を取得できます。QueryUmsThreadInformation を通じて公開されていない情報は、予約済みと見なす必要があります。

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

各言語での呼び出し定義

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

BOOL SetUmsThreadInformation(
    void* UmsThread,
    UMS_THREAD_INFO_CLASS UmsThreadInfoClass,
    void* UmsThreadInformation,
    DWORD UmsThreadInformationLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetUmsThreadInformation(
    IntPtr UmsThread,   // void*
    int UmsThreadInfoClass,   // UMS_THREAD_INFO_CLASS
    IntPtr UmsThreadInformation,   // void*
    uint UmsThreadInformationLength   // DWORD
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetUmsThreadInformation(
    UmsThread As IntPtr,   ' void*
    UmsThreadInfoClass As Integer,   ' UMS_THREAD_INFO_CLASS
    UmsThreadInformation As IntPtr,   ' void*
    UmsThreadInformationLength As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' UmsThread : void*
' UmsThreadInfoClass : UMS_THREAD_INFO_CLASS
' UmsThreadInformation : void*
' UmsThreadInformationLength : DWORD
Declare PtrSafe Function SetUmsThreadInformation Lib "kernel32" ( _
    ByVal UmsThread As LongPtr, _
    ByVal UmsThreadInfoClass As Long, _
    ByVal UmsThreadInformation As LongPtr, _
    ByVal UmsThreadInformationLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetUmsThreadInformation = ctypes.windll.kernel32.SetUmsThreadInformation
SetUmsThreadInformation.restype = wintypes.BOOL
SetUmsThreadInformation.argtypes = [
    ctypes.POINTER(None),  # UmsThread : void*
    ctypes.c_int,  # UmsThreadInfoClass : UMS_THREAD_INFO_CLASS
    ctypes.POINTER(None),  # UmsThreadInformation : void*
    wintypes.DWORD,  # UmsThreadInformationLength : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetUmsThreadInformation = Fiddle::Function.new(
  lib['SetUmsThreadInformation'],
  [
    Fiddle::TYPE_VOIDP,  # UmsThread : void*
    Fiddle::TYPE_INT,  # UmsThreadInfoClass : UMS_THREAD_INFO_CLASS
    Fiddle::TYPE_VOIDP,  # UmsThreadInformation : void*
    -Fiddle::TYPE_INT,  # UmsThreadInformationLength : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn SetUmsThreadInformation(
        UmsThread: *mut (),  // void*
        UmsThreadInfoClass: i32,  // UMS_THREAD_INFO_CLASS
        UmsThreadInformation: *mut (),  // void*
        UmsThreadInformationLength: u32  // DWORD
    ) -> 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 SetUmsThreadInformation(IntPtr UmsThread, int UmsThreadInfoClass, IntPtr UmsThreadInformation, uint UmsThreadInformationLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetUmsThreadInformation' -Namespace Win32 -PassThru
# $api::SetUmsThreadInformation(UmsThread, UmsThreadInfoClass, UmsThreadInformation, UmsThreadInformationLength)

#uselib "KERNEL32.dll"
#func global SetUmsThreadInformation "SetUmsThreadInformation" sptr, sptr, sptr, sptr
; SetUmsThreadInformation UmsThread, UmsThreadInfoClass, UmsThreadInformation, UmsThreadInformationLength   ; 戻り値は stat
; UmsThread : void* -> "sptr"
; UmsThreadInfoClass : UMS_THREAD_INFO_CLASS -> "sptr"
; UmsThreadInformation : void* -> "sptr"
; UmsThreadInformationLength : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "KERNEL32.dll"
#cfunc global SetUmsThreadInformation "SetUmsThreadInformation" sptr, int, sptr, int
; res = SetUmsThreadInformation(UmsThread, UmsThreadInfoClass, UmsThreadInformation, UmsThreadInformationLength)
; UmsThread : void* -> "sptr"
; UmsThreadInfoClass : UMS_THREAD_INFO_CLASS -> "int"
; UmsThreadInformation : void* -> "sptr"
; UmsThreadInformationLength : DWORD -> "int"

; BOOL SetUmsThreadInformation(void* UmsThread, UMS_THREAD_INFO_CLASS UmsThreadInfoClass, void* UmsThreadInformation, DWORD UmsThreadInformationLength)
#uselib "KERNEL32.dll"
#cfunc global SetUmsThreadInformation "SetUmsThreadInformation" intptr, int, intptr, int
; res = SetUmsThreadInformation(UmsThread, UmsThreadInfoClass, UmsThreadInformation, UmsThreadInformationLength)
; UmsThread : void* -> "intptr"
; UmsThreadInfoClass : UMS_THREAD_INFO_CLASS -> "int"
; UmsThreadInformation : void* -> "intptr"
; UmsThreadInformationLength : DWORD -> "int"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetUmsThreadInformation = kernel32.NewProc("SetUmsThreadInformation")
)

// UmsThread (void*), UmsThreadInfoClass (UMS_THREAD_INFO_CLASS), UmsThreadInformation (void*), UmsThreadInformationLength (DWORD)
r1, _, err := procSetUmsThreadInformation.Call(
	uintptr(UmsThread),
	uintptr(UmsThreadInfoClass),
	uintptr(UmsThreadInformation),
	uintptr(UmsThreadInformationLength),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function SetUmsThreadInformation(
  UmsThread: Pointer;   // void*
  UmsThreadInfoClass: Integer;   // UMS_THREAD_INFO_CLASS
  UmsThreadInformation: Pointer;   // void*
  UmsThreadInformationLength: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetUmsThreadInformation';

result := DllCall("KERNEL32\SetUmsThreadInformation"
    , "Ptr", UmsThread   ; void*
    , "Int", UmsThreadInfoClass   ; UMS_THREAD_INFO_CLASS
    , "Ptr", UmsThreadInformation   ; void*
    , "UInt", UmsThreadInformationLength   ; DWORD
    , "Int")   ; return: BOOL

●SetUmsThreadInformation(UmsThread, UmsThreadInfoClass, UmsThreadInformation, UmsThreadInformationLength) = DLL("KERNEL32.dll", "bool SetUmsThreadInformation(void*, int, void*, dword)")
# 呼び出し: SetUmsThreadInformation(UmsThread, UmsThreadInfoClass, UmsThreadInformation, UmsThreadInformationLength)
# UmsThread : void* -> "void*"
# UmsThreadInfoClass : UMS_THREAD_INFO_CLASS -> "int"
# UmsThreadInformation : void* -> "void*"
# UmsThreadInformationLength : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "kernel32" fn SetUmsThreadInformation(
    UmsThread: ?*anyopaque, // void*
    UmsThreadInfoClass: i32, // UMS_THREAD_INFO_CLASS
    UmsThreadInformation: ?*anyopaque, // void*
    UmsThreadInformationLength: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;

proc SetUmsThreadInformation(
    UmsThread: pointer,  # void*
    UmsThreadInfoClass: int32,  # UMS_THREAD_INFO_CLASS
    UmsThreadInformation: pointer,  # void*
    UmsThreadInformationLength: uint32  # DWORD
): int32 {.importc: "SetUmsThreadInformation", stdcall, dynlib: "KERNEL32.dll".}

pragma(lib, "kernel32");
extern(Windows)
int SetUmsThreadInformation(
    void* UmsThread,   // void*
    int UmsThreadInfoClass,   // UMS_THREAD_INFO_CLASS
    void* UmsThreadInformation,   // void*
    uint UmsThreadInformationLength   // DWORD
);

ccall((:SetUmsThreadInformation, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32, Ptr{Cvoid}, UInt32),
      UmsThread, UmsThreadInfoClass, UmsThreadInformation, UmsThreadInformationLength)
# UmsThread : void* -> Ptr{Cvoid}
# UmsThreadInfoClass : UMS_THREAD_INFO_CLASS -> Int32
# UmsThreadInformation : void* -> Ptr{Cvoid}
# UmsThreadInformationLength : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t SetUmsThreadInformation(
    void* UmsThread,
    int32_t UmsThreadInfoClass,
    void* UmsThreadInformation,
    uint32_t UmsThreadInformationLength);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetUmsThreadInformation(UmsThread, UmsThreadInfoClass, UmsThreadInformation, UmsThreadInformationLength)
-- UmsThread : void*
-- UmsThreadInfoClass : UMS_THREAD_INFO_CLASS
-- UmsThreadInformation : void*
-- UmsThreadInformationLength : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetUmsThreadInformation = lib.func('__stdcall', 'SetUmsThreadInformation', 'int32_t', ['void *', 'int32_t', 'void *', 'uint32_t']);
// SetUmsThreadInformation(UmsThread, UmsThreadInfoClass, UmsThreadInformation, UmsThreadInformationLength)
// UmsThread : void* -> 'void *'
// UmsThreadInfoClass : UMS_THREAD_INFO_CLASS -> 'int32_t'
// UmsThreadInformation : void* -> 'void *'
// UmsThreadInformationLength : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("KERNEL32.dll", {
  SetUmsThreadInformation: { parameters: ["pointer", "i32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SetUmsThreadInformation(UmsThread, UmsThreadInfoClass, UmsThreadInformation, UmsThreadInformationLength)
// UmsThread : void* -> "pointer"
// UmsThreadInfoClass : UMS_THREAD_INFO_CLASS -> "i32"
// UmsThreadInformation : void* -> "pointer"
// UmsThreadInformationLength : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t SetUmsThreadInformation(
    void* UmsThread,
    int32_t UmsThreadInfoClass,
    void* UmsThreadInformation,
    uint32_t UmsThreadInformationLength);
C, "KERNEL32.dll");
// $ffi->SetUmsThreadInformation(UmsThread, UmsThreadInfoClass, UmsThreadInformation, UmsThreadInformationLength);
// UmsThread : void*
// UmsThreadInfoClass : UMS_THREAD_INFO_CLASS
// UmsThreadInformation : void*
// UmsThreadInformationLength : 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);
    boolean SetUmsThreadInformation(
        Pointer UmsThread,   // void*
        int UmsThreadInfoClass,   // UMS_THREAD_INFO_CLASS
        Pointer UmsThreadInformation,   // void*
        int UmsThreadInformationLength   // DWORD
    );
}

@[Link("kernel32")]
lib LibKERNEL32
  fun SetUmsThreadInformation = SetUmsThreadInformation(
    UmsThread : Void*,   # void*
    UmsThreadInfoClass : Int32,   # UMS_THREAD_INFO_CLASS
    UmsThreadInformation : Void*,   # void*
    UmsThreadInformationLength : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetUmsThreadInformationNative = Int32 Function(Pointer<Void>, Int32, Pointer<Void>, Uint32);
typedef SetUmsThreadInformationDart = int Function(Pointer<Void>, int, Pointer<Void>, int);
final SetUmsThreadInformation = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetUmsThreadInformationNative, SetUmsThreadInformationDart>('SetUmsThreadInformation');
// UmsThread : void* -> Pointer<Void>
// UmsThreadInfoClass : UMS_THREAD_INFO_CLASS -> Int32
// UmsThreadInformation : void* -> Pointer<Void>
// UmsThreadInformationLength : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function SetUmsThreadInformation(
  UmsThread: Pointer;   // void*
  UmsThreadInfoClass: Integer;   // UMS_THREAD_INFO_CLASS
  UmsThreadInformation: Pointer;   // void*
  UmsThreadInformationLength: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetUmsThreadInformation';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetUmsThreadInformation"
  c_SetUmsThreadInformation :: Ptr () -> Int32 -> Ptr () -> Word32 -> IO CInt
-- UmsThread : void* -> Ptr ()
-- UmsThreadInfoClass : UMS_THREAD_INFO_CLASS -> Int32
-- UmsThreadInformation : void* -> Ptr ()
-- UmsThreadInformationLength : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let setumsthreadinformation =
  foreign "SetUmsThreadInformation"
    ((ptr void) @-> int32_t @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* UmsThread : void* -> (ptr void) *)
(* UmsThreadInfoClass : UMS_THREAD_INFO_CLASS -> int32_t *)
(* UmsThreadInformation : void* -> (ptr void) *)
(* UmsThreadInformationLength : 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 ("SetUmsThreadInformation" set-ums-thread-information :convention :stdcall) :int32
  (ums-thread :pointer)   ; void*
  (ums-thread-info-class :int32)   ; UMS_THREAD_INFO_CLASS
  (ums-thread-information :pointer)   ; void*
  (ums-thread-information-length :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $SetUmsThreadInformation = Win32::API::More->new('KERNEL32',
    'BOOL SetUmsThreadInformation(LPVOID UmsThread, int UmsThreadInfoClass, LPVOID UmsThreadInformation, DWORD UmsThreadInformationLength)');
# my $ret = $SetUmsThreadInformation->Call($UmsThread, $UmsThreadInfoClass, $UmsThreadInformation, $UmsThreadInformationLength);
# UmsThread : void* -> LPVOID
# UmsThreadInfoClass : UMS_THREAD_INFO_CLASS -> int
# UmsThreadInformation : void* -> LPVOID
# UmsThreadInformationLength : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。