ホーム › System.Threading › QueryUmsThreadInformation

QueryUmsThreadInformation

関数

指定のUMSスレッドの情報を問い合わせて取得する。

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

シグネチャ

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

BOOL QueryUmsThreadInformation(
    void* UmsThread,
    UMS_THREAD_INFO_CLASS UmsThreadInfoClass,
    void* UmsThreadInformation,
    DWORD UmsThreadInformationLength,
    DWORD* ReturnLength   // optional
);

パラメーター

名前	型	方向	説明
UmsThread	void*	in	UMS スレッドコンテキストへのポインター。
UmsThreadInfoClass	UMS_THREAD_INFO_CLASS	in	取得する情報の種類を指定する UMS_THREAD_INFO_CLASS 値。
UmsThreadInformation	void*	out	指定した情報を受け取るバッファーへのポインター。このバッファーに必要なサイズは、指定する情報クラスによって異なります。情報クラスが UmsThreadContext または UmsThreadTeb の場合、バッファーは `sizeof(PVOID)` である必要があります。情報クラスが UmsThreadIsSuspended または UmsThreadIsTerminated の場合、バッファーは `sizeof(BOOLEAN)` である必要があります。
UmsThreadInformationLength	DWORD	in	UmsThreadInformation バッファーのサイズ (バイト単位)。
ReturnLength	DWORD*	outoptional	ULONG 変数へのポインター。出力時に、このパラメーターは UmsThreadInformation バッファーに書き込まれたバイト数を受け取ります。

戻り値の型: BOOL

公式ドキュメント

指定したユーザーモードスケジューリング (UMS) ワーカースレッドに関する情報を取得します。

戻り値

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

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

戻り値	説明
ERROR_INFO_LENGTH_MISMATCH	要求された情報に対してバッファーが小さすぎます。
ERROR_INVALID_INFO_CLASS	指定された情報クラスはサポートされていません。
ERROR_NOT_SUPPORTED	UMS はサポートされていません。

解説(Remarks)

QueryUmsThreadInformation 関数は、指定した UMS ワーカースレッドに関する情報 (アプリケーション定義のコンテキスト、スレッド実行ブロック (TEB)、スレッドが中断または終了しているかどうかなど) を取得します。

UMS ワーカースレッドの基になる構造体はシステムによって管理されます。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 QueryUmsThreadInformation(
    void* UmsThread,
    UMS_THREAD_INFO_CLASS UmsThreadInfoClass,
    void* UmsThreadInformation,
    DWORD UmsThreadInformationLength,
    DWORD* ReturnLength   // optional
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

#uselib "KERNEL32.dll"
#cfunc global QueryUmsThreadInformation "QueryUmsThreadInformation" sptr, int, sptr, int, var
; res = QueryUmsThreadInformation(UmsThread, UmsThreadInfoClass, UmsThreadInformation, UmsThreadInformationLength, ReturnLength)
; UmsThread : void* -> "sptr"
; UmsThreadInfoClass : UMS_THREAD_INFO_CLASS -> "int"
; UmsThreadInformation : void* out -> "sptr"
; UmsThreadInformationLength : DWORD -> "int"
; ReturnLength : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global QueryUmsThreadInformation "QueryUmsThreadInformation" sptr, int, sptr, int, sptr
; res = QueryUmsThreadInformation(UmsThread, UmsThreadInfoClass, UmsThreadInformation, UmsThreadInformationLength, varptr(ReturnLength))
; UmsThread : void* -> "sptr"
; UmsThreadInfoClass : UMS_THREAD_INFO_CLASS -> "int"
; UmsThreadInformation : void* out -> "sptr"
; UmsThreadInformationLength : DWORD -> "int"
; ReturnLength : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。