ホーム › System.Threading › GetUmsSystemThreadInformation

GetUmsSystemThreadInformation

関数

指定スレッドがUMSスレッドかどうかの情報を取得する。

DLLKERNEL32.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

BOOL GetUmsSystemThreadInformation(
    HANDLE ThreadHandle,
    UMS_SYSTEM_THREAD_INFORMATION* SystemThreadInfo
);

パラメーター

名前型方向説明

ThreadHandle HANDLE in スレッドへのハンドルです。このスレッドハンドルには THREAD_QUERY_INFORMATION アクセス権が必要です。詳細については、「Thread Security and Access Rights」を参照してください。

SystemThreadInfo

名前	型	方向	説明
ThreadHandle	HANDLE	in	スレッドへのハンドルです。このスレッドハンドルには THREAD_QUERY_INFORMATION アクセス権が必要です。詳細については、「Thread Security and Access Rights」を参照してください。
SystemThreadInfo	UMS_SYSTEM_THREAD_INFORMATION*	inout	指定されたスレッドに関する情報を受け取る UMS_SYSTEM_THREAD_INFORMATION 構造体へのポインターです。呼び出し元は、呼び出す前に `UmsVersion` メンバーを初期化する必要があります。

UMS_SYSTEM_THREAD_INFORMATION*

inout

指定されたスレッドに関する情報を受け取る UMS_SYSTEM_THREAD_INFORMATION 構造体へのポインターです。

呼び出し元は、呼び出す前に UmsVersion メンバーを初期化する必要があります。

戻り値の型: BOOL

公式ドキュメント

指定されたスレッドが UMS スケジューラスレッド、UMS ワーカースレッド、または UMS 以外のスレッドのいずれであるかを照会します。

戻り値

関数が失敗した場合、戻り値は 0 です。

拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

GetUmsSystemThreadInformation 関数は、デバッガー、トラブルシューティングツール、およびプロファイリングアプリケーションでの使用を目的としています。たとえば、スレッドを分離したトレースや命令のシングルステップ実行では、プロセス内の他のすべてのスレッドを中断することがあります。しかし、トレース対象のスレッドが UMS ワーカースレッドである場合、UMS スケジューラスレッドを中断するとデッドロックが発生する可能性があります。これは、UMS ワーカースレッドが実行されるためには UMS スケジューラスレッドの介在が必要となるためです。デバッガーは、中断する可能性のある各スレッドに対して GetUmsSystemThreadInformation を呼び出してスレッドの種類を判別し、デバッグ対象のコードに応じて中断するかどうかを決定できます。

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

各言語での呼び出し定義

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

BOOL GetUmsSystemThreadInformation(
    HANDLE ThreadHandle,
    UMS_SYSTEM_THREAD_INFORMATION* SystemThreadInfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool GetUmsSystemThreadInformation(
    IntPtr ThreadHandle,   // HANDLE
    IntPtr SystemThreadInfo   // UMS_SYSTEM_THREAD_INFORMATION* in/out
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function GetUmsSystemThreadInformation(
    ThreadHandle As IntPtr,   ' HANDLE
    SystemThreadInfo As IntPtr   ' UMS_SYSTEM_THREAD_INFORMATION* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' ThreadHandle : HANDLE
' SystemThreadInfo : UMS_SYSTEM_THREAD_INFORMATION* in/out
Declare PtrSafe Function GetUmsSystemThreadInformation Lib "kernel32" ( _
    ByVal ThreadHandle As LongPtr, _
    ByVal SystemThreadInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetUmsSystemThreadInformation = ctypes.windll.kernel32.GetUmsSystemThreadInformation
GetUmsSystemThreadInformation.restype = wintypes.BOOL
GetUmsSystemThreadInformation.argtypes = [
    wintypes.HANDLE,  # ThreadHandle : HANDLE
    ctypes.c_void_p,  # SystemThreadInfo : UMS_SYSTEM_THREAD_INFORMATION* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetUmsSystemThreadInformation = Fiddle::Function.new(
  lib['GetUmsSystemThreadInformation'],
  [
    Fiddle::TYPE_VOIDP,  # ThreadHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # SystemThreadInfo : UMS_SYSTEM_THREAD_INFORMATION* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetUmsSystemThreadInformation(
        ThreadHandle: *mut core::ffi::c_void,  // HANDLE
        SystemThreadInfo: *mut UMS_SYSTEM_THREAD_INFORMATION  // UMS_SYSTEM_THREAD_INFORMATION* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool GetUmsSystemThreadInformation(IntPtr ThreadHandle, IntPtr SystemThreadInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetUmsSystemThreadInformation' -Namespace Win32 -PassThru
# $api::GetUmsSystemThreadInformation(ThreadHandle, SystemThreadInfo)

#uselib "KERNEL32.dll"
#func global GetUmsSystemThreadInformation "GetUmsSystemThreadInformation" sptr, sptr
; GetUmsSystemThreadInformation ThreadHandle, varptr(SystemThreadInfo)   ; 戻り値は stat
; ThreadHandle : HANDLE -> "sptr"
; SystemThreadInfo : UMS_SYSTEM_THREAD_INFORMATION* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetUmsSystemThreadInformation "GetUmsSystemThreadInformation" sptr, var
; res = GetUmsSystemThreadInformation(ThreadHandle, SystemThreadInfo)
; ThreadHandle : HANDLE -> "sptr"
; SystemThreadInfo : UMS_SYSTEM_THREAD_INFORMATION* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetUmsSystemThreadInformation "GetUmsSystemThreadInformation" sptr, sptr
; res = GetUmsSystemThreadInformation(ThreadHandle, varptr(SystemThreadInfo))
; ThreadHandle : HANDLE -> "sptr"
; SystemThreadInfo : UMS_SYSTEM_THREAD_INFORMATION* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。