ホーム › System.Threading › GetExitCodeThread
GetExitCodeThread
関数指定スレッドの終了コードを取得する。
シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL GetExitCodeThread(
HANDLE hThread,
DWORD* lpExitCode
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hThread | HANDLE | in | スレッドへのハンドル。 このハンドルには THREAD_QUERY_INFORMATION または THREAD_QUERY_LIMITED_INFORMATION アクセス権が必要です。詳細については、 Thread Security and Access Rights を参照してください。 Windows Server 2003 および Windows XP: このハンドルには THREAD_QUERY_INFORMATION アクセス権が必要です。 |
| lpExitCode | DWORD* | out | スレッドの終了ステータスを受け取る変数へのポインター。詳細については「解説」を参照してください。 |
戻り値の型: BOOL
公式ドキュメント
指定したスレッドの終了ステータスを取得します。
戻り値
関数が成功した場合、戻り値は 0 以外の値です。
関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出してください。
解説(Remarks)
この関数はすぐに戻ります。指定したスレッドがまだ終了しておらず、関数が成功した場合、返されるステータスは STILL_ACTIVE です。スレッドが終了しており、関数が成功した場合、返されるステータスは次のいずれかの値です。
- ExitThread または TerminateThread 関数で指定された終了値。
- スレッド関数からの戻り値。
- スレッドが属するプロセスの終了値。
重要 GetExitCodeThread 関数がアプリケーションで定義された有効なエラーコードを返すのは、スレッドが終了した後だけです。したがって、アプリケーションは STILL_ACTIVE (259) をエラーコードとして使用すべきではありません。スレッドが STILL_ACTIVE (259) をエラーコードとして返した場合、この値を検査するアプリケーションは、スレッドがまだ実行中であると解釈し、スレッドが既に終了した後もスレッドの完了を検査し続けてしまい、アプリケーションが無限ループに陥る可能性があります。この問題を回避するため、呼び出し側はスレッドが終了したことを確認した後にのみ GetExitCodeThread 関数を呼び出してください。スレッドが終了したかどうかを判定するには、待機時間を 0 に指定した WaitForSingleObject 関数を使用してください。
Windows 8.1 および Windows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストアアプリでサポートされています。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
BOOL GetExitCodeThread(
HANDLE hThread,
DWORD* lpExitCode
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetExitCodeThread(
IntPtr hThread, // HANDLE
out uint lpExitCode // DWORD* out
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetExitCodeThread(
hThread As IntPtr, ' HANDLE
<Out> ByRef lpExitCode As UInteger ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hThread : HANDLE
' lpExitCode : DWORD* out
Declare PtrSafe Function GetExitCodeThread Lib "kernel32" ( _
ByVal hThread As LongPtr, _
ByRef lpExitCode As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
GetExitCodeThread = ctypes.windll.kernel32.GetExitCodeThread
GetExitCodeThread.restype = wintypes.BOOL
GetExitCodeThread.argtypes = [
wintypes.HANDLE, # hThread : HANDLE
ctypes.POINTER(wintypes.DWORD), # lpExitCode : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
GetExitCodeThread = Fiddle::Function.new(
lib['GetExitCodeThread'],
[
Fiddle::TYPE_VOIDP, # hThread : HANDLE
Fiddle::TYPE_VOIDP, # lpExitCode : DWORD* out
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn GetExitCodeThread(
hThread: *mut core::ffi::c_void, // HANDLE
lpExitCode: *mut u32 // DWORD* 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 GetExitCodeThread(IntPtr hThread, out uint lpExitCode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetExitCodeThread' -Namespace Win32 -PassThru
# $api::GetExitCodeThread(hThread, lpExitCode)#uselib "KERNEL32.dll"
#func global GetExitCodeThread "GetExitCodeThread" sptr, sptr
; GetExitCodeThread hThread, varptr(lpExitCode) ; 戻り値は stat
; hThread : HANDLE -> "sptr"
; lpExitCode : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "KERNEL32.dll" #cfunc global GetExitCodeThread "GetExitCodeThread" sptr, var ; res = GetExitCodeThread(hThread, lpExitCode) ; hThread : HANDLE -> "sptr" ; lpExitCode : DWORD* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global GetExitCodeThread "GetExitCodeThread" sptr, sptr ; res = GetExitCodeThread(hThread, varptr(lpExitCode)) ; hThread : HANDLE -> "sptr" ; lpExitCode : DWORD* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL GetExitCodeThread(HANDLE hThread, DWORD* lpExitCode) #uselib "KERNEL32.dll" #cfunc global GetExitCodeThread "GetExitCodeThread" intptr, var ; res = GetExitCodeThread(hThread, lpExitCode) ; hThread : HANDLE -> "intptr" ; lpExitCode : DWORD* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL GetExitCodeThread(HANDLE hThread, DWORD* lpExitCode) #uselib "KERNEL32.dll" #cfunc global GetExitCodeThread "GetExitCodeThread" intptr, intptr ; res = GetExitCodeThread(hThread, varptr(lpExitCode)) ; hThread : HANDLE -> "intptr" ; lpExitCode : DWORD* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procGetExitCodeThread = kernel32.NewProc("GetExitCodeThread")
)
// hThread (HANDLE), lpExitCode (DWORD* out)
r1, _, err := procGetExitCodeThread.Call(
uintptr(hThread),
uintptr(lpExitCode),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction GetExitCodeThread(
hThread: THandle; // HANDLE
lpExitCode: Pointer // DWORD* out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'GetExitCodeThread';result := DllCall("KERNEL32\GetExitCodeThread"
, "Ptr", hThread ; HANDLE
, "Ptr", lpExitCode ; DWORD* out
, "Int") ; return: BOOL●GetExitCodeThread(hThread, lpExitCode) = DLL("KERNEL32.dll", "bool GetExitCodeThread(void*, void*)")
# 呼び出し: GetExitCodeThread(hThread, lpExitCode)
# hThread : HANDLE -> "void*"
# lpExitCode : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn GetExitCodeThread(
hThread: ?*anyopaque, // HANDLE
lpExitCode: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;proc GetExitCodeThread(
hThread: pointer, # HANDLE
lpExitCode: ptr uint32 # DWORD* out
): int32 {.importc: "GetExitCodeThread", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int GetExitCodeThread(
void* hThread, // HANDLE
uint* lpExitCode // DWORD* out
);ccall((:GetExitCodeThread, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{UInt32}),
hThread, lpExitCode)
# hThread : HANDLE -> Ptr{Cvoid}
# lpExitCode : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t GetExitCodeThread(
void* hThread,
uint32_t* lpExitCode);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetExitCodeThread(hThread, lpExitCode)
-- hThread : HANDLE
-- lpExitCode : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetExitCodeThread = lib.func('__stdcall', 'GetExitCodeThread', 'int32_t', ['void *', 'uint32_t *']);
// GetExitCodeThread(hThread, lpExitCode)
// hThread : HANDLE -> 'void *'
// lpExitCode : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
GetExitCodeThread: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.GetExitCodeThread(hThread, lpExitCode)
// hThread : HANDLE -> "pointer"
// lpExitCode : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t GetExitCodeThread(
void* hThread,
uint32_t* lpExitCode);
C, "KERNEL32.dll");
// $ffi->GetExitCodeThread(hThread, lpExitCode);
// hThread : HANDLE
// lpExitCode : DWORD* 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 GetExitCodeThread(
Pointer hThread, // HANDLE
IntByReference lpExitCode // DWORD* out
);
}@[Link("kernel32")]
lib LibKERNEL32
fun GetExitCodeThread = GetExitCodeThread(
hThread : Void*, # HANDLE
lpExitCode : UInt32* # DWORD* out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef GetExitCodeThreadNative = Int32 Function(Pointer<Void>, Pointer<Uint32>);
typedef GetExitCodeThreadDart = int Function(Pointer<Void>, Pointer<Uint32>);
final GetExitCodeThread = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<GetExitCodeThreadNative, GetExitCodeThreadDart>('GetExitCodeThread');
// hThread : HANDLE -> Pointer<Void>
// lpExitCode : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetExitCodeThread(
hThread: THandle; // HANDLE
lpExitCode: Pointer // DWORD* out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'GetExitCodeThread';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetExitCodeThread"
c_GetExitCodeThread :: Ptr () -> Ptr Word32 -> IO CInt
-- hThread : HANDLE -> Ptr ()
-- lpExitCode : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getexitcodethread =
foreign "GetExitCodeThread"
((ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* hThread : HANDLE -> (ptr void) *)
(* lpExitCode : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("GetExitCodeThread" get-exit-code-thread :convention :stdcall) :int32
(h-thread :pointer) ; HANDLE
(lp-exit-code :pointer)) ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GetExitCodeThread = Win32::API::More->new('KERNEL32',
'BOOL GetExitCodeThread(HANDLE hThread, LPVOID lpExitCode)');
# my $ret = $GetExitCodeThread->Call($hThread, $lpExitCode);
# hThread : HANDLE -> HANDLE
# lpExitCode : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f ExitThread — 呼び出し元スレッドを指定した終了コードで終了する。
- f GetExitCodeProcess — 指定プロセスの終了コードを取得する。
- f OpenThread — 指定した識別子の既存スレッドを開く。
- f TerminateThread — 対象スレッドを強制的に終了させる。