Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › GetGUIThreadInfo

GetGUIThreadInfo

関数
指定スレッドのGUI状態情報を取得する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetGUIThreadInfo(
    DWORD idThread,
    GUITHREADINFO* pgui
);

パラメーター

名前方向説明
idThreadDWORDin情報を取得するスレッドの識別子です。この値を取得するには、GetWindowThreadProcessId 関数を使用します。このパラメーターが NULL の場合、関数はフォアグラウンドスレッドの情報を返します。
pguiGUITHREADINFO*inoutスレッドを記述する情報を受け取る GUITHREADINFO 構造体へのポインターです。この関数を呼び出す前に、cbSize メンバーに sizeof(GUITHREADINFO) を設定する必要があることに注意してください。

戻り値の型: BOOL

公式ドキュメント

アクティブウィンドウまたは指定した GUI スレッドに関する情報を取得します。

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

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

解説(Remarks)

この関数は、アクティブウィンドウが呼び出し元のプロセスによって所有されていない場合でも成功します。指定したスレッドが存在しない、または入力キューを持たない場合、関数は失敗します。

この関数は、スレッドに関するコンテキスト外の情報を取得するのに役立ちます。取得される情報は、アプリケーションが自身に関する情報を取得した場合と同じです。

エディットコントロールの場合、返される rcCaret 四角形にはキャレットに加えて、テキストの方向やパディングに関する情報が含まれます。そのため、カーソルの正確な位置を示さない場合があります。Sans Serif フォントでは、カーソルに 4 つの文字が使用されます。

カーソル文字 Unicode コードポイント
CURSOR_LTR 0xf00c
CURSOR_RTL 0xf00d
CURSOR_THAI 0xf00e
CURSOR_USA 0xfff (これは関連付けられたグリフを持たないマーカー値です)

rcCaret 四角形内の実際の挿入ポイントを取得するには、次の手順を実行します。

  1. GetKeyboardLayout を呼び出して、現在の入力言語を取得します。
  2. 現在の入力言語に基づいて、カーソルに使用される文字を判別します。
  3. フォントに Sans Serif、rcCaret で指定される高さ、幅 zero を指定して CreateFont を呼び出します。fnWeight については、SystemParametersInfo(SPI_GETCARETWIDTH, 0, pvParam, 0) を呼び出します。pvParam が 1 より大きい場合は fnWeight を 700 に設定し、それ以外の場合は fnWeight を 400 に設定します。
  4. フォントをデバイスコンテキスト (DC) に選択し、GetCharABCWidths を使用して適切なカーソル文字の B 幅を取得します。
  5. B 幅を rcCaret.left に加算して、実際の挿入ポイントを取得します。

ウィンドウがアクティブ化を失いつつある場合など、フォアグラウンドスレッドの情報を取得するために呼び出されたとき、この関数は GUITHREADINFO 構造体内に有効なウィンドウハンドルを返さないことがあります。

DPI 仮想化

GUITHREADINFO 構造体の rcCaret 矩形で返される座標は、キャレットに関連付けられたウィンドウを基準とした論理座標です。これらは呼び出し元スレッドのモードに仮想化されません。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL GetGUIThreadInfo(
    DWORD idThread,
    GUITHREADINFO* pgui
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetGUIThreadInfo(
    uint idThread,   // DWORD
    IntPtr pgui   // GUITHREADINFO* in/out
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetGUIThreadInfo(
    idThread As UInteger,   ' DWORD
    pgui As IntPtr   ' GUITHREADINFO* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' idThread : DWORD
' pgui : GUITHREADINFO* in/out
Declare PtrSafe Function GetGUIThreadInfo Lib "user32" ( _
    ByVal idThread As Long, _
    ByVal pgui As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetGUIThreadInfo = ctypes.windll.user32.GetGUIThreadInfo
GetGUIThreadInfo.restype = wintypes.BOOL
GetGUIThreadInfo.argtypes = [
    wintypes.DWORD,  # idThread : DWORD
    ctypes.c_void_p,  # pgui : GUITHREADINFO* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetGUIThreadInfo = Fiddle::Function.new(
  lib['GetGUIThreadInfo'],
  [
    -Fiddle::TYPE_INT,  # idThread : DWORD
    Fiddle::TYPE_VOIDP,  # pgui : GUITHREADINFO* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn GetGUIThreadInfo(
        idThread: u32,  // DWORD
        pgui: *mut GUITHREADINFO  // GUITHREADINFO* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool GetGUIThreadInfo(uint idThread, IntPtr pgui);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetGUIThreadInfo' -Namespace Win32 -PassThru
# $api::GetGUIThreadInfo(idThread, pgui)
#uselib "USER32.dll"
#func global GetGUIThreadInfo "GetGUIThreadInfo" sptr, sptr
; GetGUIThreadInfo idThread, varptr(pgui)   ; 戻り値は stat
; idThread : DWORD -> "sptr"
; pgui : GUITHREADINFO* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global GetGUIThreadInfo "GetGUIThreadInfo" int, var
; res = GetGUIThreadInfo(idThread, pgui)
; idThread : DWORD -> "int"
; pgui : GUITHREADINFO* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetGUIThreadInfo(DWORD idThread, GUITHREADINFO* pgui)
#uselib "USER32.dll"
#cfunc global GetGUIThreadInfo "GetGUIThreadInfo" int, var
; res = GetGUIThreadInfo(idThread, pgui)
; idThread : DWORD -> "int"
; pgui : GUITHREADINFO* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetGUIThreadInfo = user32.NewProc("GetGUIThreadInfo")
)

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

extern "user32" fn GetGUIThreadInfo(
    idThread: u32, // DWORD
    pgui: [*c]GUITHREADINFO // GUITHREADINFO* in/out
) callconv(std.os.windows.WINAPI) i32;
proc GetGUIThreadInfo(
    idThread: uint32,  # DWORD
    pgui: ptr GUITHREADINFO  # GUITHREADINFO* in/out
): int32 {.importc: "GetGUIThreadInfo", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int GetGUIThreadInfo(
    uint idThread,   // DWORD
    GUITHREADINFO* pgui   // GUITHREADINFO* in/out
);
ccall((:GetGUIThreadInfo, "USER32.dll"), stdcall, Int32,
      (UInt32, Ptr{GUITHREADINFO}),
      idThread, pgui)
# idThread : DWORD -> UInt32
# pgui : GUITHREADINFO* in/out -> Ptr{GUITHREADINFO}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetGUIThreadInfo(
    uint32_t idThread,
    void* pgui);
]]
local user32 = ffi.load("user32")
-- user32.GetGUIThreadInfo(idThread, pgui)
-- idThread : DWORD
-- pgui : GUITHREADINFO* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetGUIThreadInfo = lib.func('__stdcall', 'GetGUIThreadInfo', 'int32_t', ['uint32_t', 'void *']);
// GetGUIThreadInfo(idThread, pgui)
// idThread : DWORD -> 'uint32_t'
// pgui : GUITHREADINFO* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetGUIThreadInfo: { parameters: ["u32", "pointer"], result: "i32" },
});
// lib.symbols.GetGUIThreadInfo(idThread, pgui)
// idThread : DWORD -> "u32"
// pgui : GUITHREADINFO* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetGUIThreadInfo(
    uint32_t idThread,
    void* pgui);
C, "USER32.dll");
// $ffi->GetGUIThreadInfo(idThread, pgui);
// idThread : DWORD
// pgui : GUITHREADINFO* 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 User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class);
    boolean GetGUIThreadInfo(
        int idThread,   // DWORD
        Pointer pgui   // GUITHREADINFO* in/out
    );
}
@[Link("user32")]
lib LibUSER32
  fun GetGUIThreadInfo = GetGUIThreadInfo(
    idThread : UInt32,   # DWORD
    pgui : GUITHREADINFO*   # GUITHREADINFO* 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 GetGUIThreadInfoNative = Int32 Function(Uint32, Pointer<Void>);
typedef GetGUIThreadInfoDart = int Function(int, Pointer<Void>);
final GetGUIThreadInfo = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetGUIThreadInfoNative, GetGUIThreadInfoDart>('GetGUIThreadInfo');
// idThread : DWORD -> Uint32
// pgui : GUITHREADINFO* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetGUIThreadInfo(
  idThread: DWORD;   // DWORD
  pgui: Pointer   // GUITHREADINFO* in/out
): BOOL; stdcall;
  external 'USER32.dll' name 'GetGUIThreadInfo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetGUIThreadInfo"
  c_GetGUIThreadInfo :: Word32 -> Ptr () -> IO CInt
-- idThread : DWORD -> Word32
-- pgui : GUITHREADINFO* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getguithreadinfo =
  foreign "GetGUIThreadInfo"
    (uint32_t @-> (ptr void) @-> returning int32_t)
(* idThread : DWORD -> uint32_t *)
(* pgui : GUITHREADINFO* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("GetGUIThreadInfo" get-guithread-info :convention :stdcall) :int32
  (id-thread :uint32)   ; DWORD
  (pgui :pointer))   ; GUITHREADINFO* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetGUIThreadInfo = Win32::API::More->new('USER32',
    'BOOL GetGUIThreadInfo(DWORD idThread, LPVOID pgui)');
# my $ret = $GetGUIThreadInfo->Call($idThread, $pgui);
# idThread : DWORD -> DWORD
# pgui : GUITHREADINFO* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型