Win32 API 日本語リファレンス
ホームSystem.Threading › DeleteUmsThreadContext

DeleteUmsThreadContext

関数
UMSスレッドコンテキストを削除し、リソースを解放する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 7 以降

シグネチャ

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

BOOL DeleteUmsThreadContext(
    void* UmsThread
);

パラメーター

名前方向説明
UmsThreadvoid*in削除する UMS スレッドコンテキストへのポインター。このポインターは CreateUmsThreadContext 関数によって提供されます。

戻り値の型: BOOL

公式ドキュメント

指定したユーザーモードスケジューリング (UMS) スレッドコンテキストを削除します。スレッドは終了している必要があります。

戻り値

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

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

解説(Remarks)

UMS スレッドコンテキストは、関連付けられたスレッドが終了するまで削除できません。

UMS ワーカースレッドの実行が完了すると (たとえばスレッドのエントリポイント関数から戻った場合など)、システムはスレッドを終了させ、そのスレッドの UMS スレッドコンテキストに終了ステータスを設定し、UMS スレッドコンテキストを関連付けられた完了リストにキューイングします。

スレッドは既に終了しているため、その UMS スレッドの実行を試みても失敗します。

スレッドの終了ステータスを確認するには、アプリケーションのスケジューラーが UmsIsThreadTerminated 情報クラスを指定して 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 DeleteUmsThreadContext(
    void* UmsThread
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool DeleteUmsThreadContext(
    IntPtr UmsThread   // void*
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DeleteUmsThreadContext(
    UmsThread As IntPtr   ' void*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' UmsThread : void*
Declare PtrSafe Function DeleteUmsThreadContext Lib "kernel32" ( _
    ByVal UmsThread As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DeleteUmsThreadContext = ctypes.windll.kernel32.DeleteUmsThreadContext
DeleteUmsThreadContext.restype = wintypes.BOOL
DeleteUmsThreadContext.argtypes = [
    ctypes.POINTER(None),  # UmsThread : void*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
DeleteUmsThreadContext = Fiddle::Function.new(
  lib['DeleteUmsThreadContext'],
  [
    Fiddle::TYPE_VOIDP,  # UmsThread : void*
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn DeleteUmsThreadContext(
        UmsThread: *mut ()  // void*
    ) -> 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 DeleteUmsThreadContext(IntPtr UmsThread);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_DeleteUmsThreadContext' -Namespace Win32 -PassThru
# $api::DeleteUmsThreadContext(UmsThread)
#uselib "KERNEL32.dll"
#func global DeleteUmsThreadContext "DeleteUmsThreadContext" sptr
; DeleteUmsThreadContext UmsThread   ; 戻り値は stat
; UmsThread : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global DeleteUmsThreadContext "DeleteUmsThreadContext" sptr
; res = DeleteUmsThreadContext(UmsThread)
; UmsThread : void* -> "sptr"
; BOOL DeleteUmsThreadContext(void* UmsThread)
#uselib "KERNEL32.dll"
#cfunc global DeleteUmsThreadContext "DeleteUmsThreadContext" intptr
; res = DeleteUmsThreadContext(UmsThread)
; UmsThread : void* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procDeleteUmsThreadContext = kernel32.NewProc("DeleteUmsThreadContext")
)

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

extern "kernel32" fn DeleteUmsThreadContext(
    UmsThread: ?*anyopaque // void*
) callconv(std.os.windows.WINAPI) i32;
proc DeleteUmsThreadContext(
    UmsThread: pointer  # void*
): int32 {.importc: "DeleteUmsThreadContext", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int DeleteUmsThreadContext(
    void* UmsThread   // void*
);
ccall((:DeleteUmsThreadContext, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid},),
      UmsThread)
# UmsThread : void* -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t DeleteUmsThreadContext(
    void* UmsThread);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.DeleteUmsThreadContext(UmsThread)
-- UmsThread : void*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const DeleteUmsThreadContext = lib.func('__stdcall', 'DeleteUmsThreadContext', 'int32_t', ['void *']);
// DeleteUmsThreadContext(UmsThread)
// UmsThread : void* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  DeleteUmsThreadContext: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.DeleteUmsThreadContext(UmsThread)
// UmsThread : void* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DeleteUmsThreadContext(
    void* UmsThread);
C, "KERNEL32.dll");
// $ffi->DeleteUmsThreadContext(UmsThread);
// UmsThread : void*
// 構造体/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 DeleteUmsThreadContext(
        Pointer UmsThread   // void*
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun DeleteUmsThreadContext = DeleteUmsThreadContext(
    UmsThread : Void*   # void*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DeleteUmsThreadContextNative = Int32 Function(Pointer<Void>);
typedef DeleteUmsThreadContextDart = int Function(Pointer<Void>);
final DeleteUmsThreadContext = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<DeleteUmsThreadContextNative, DeleteUmsThreadContextDart>('DeleteUmsThreadContext');
// UmsThread : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DeleteUmsThreadContext(
  UmsThread: Pointer   // void*
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'DeleteUmsThreadContext';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DeleteUmsThreadContext"
  c_DeleteUmsThreadContext :: Ptr () -> IO CInt
-- UmsThread : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let deleteumsthreadcontext =
  foreign "DeleteUmsThreadContext"
    ((ptr void) @-> returning int32_t)
(* UmsThread : void* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("DeleteUmsThreadContext" delete-ums-thread-context :convention :stdcall) :int32
  (ums-thread :pointer))   ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DeleteUmsThreadContext = Win32::API::More->new('KERNEL32',
    'BOOL DeleteUmsThreadContext(LPVOID UmsThread)');
# my $ret = $DeleteUmsThreadContext->Call($UmsThread);
# UmsThread : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目