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

SetThreadDescription

関数
スレッドに説明用の名前を設定する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

HRESULT SetThreadDescription(
    HANDLE hThread,
    LPCWSTR lpThreadDescription
);

パラメーター

名前方向説明
hThreadHANDLEin説明を設定するスレッドのハンドルです。このハンドルには THREAD_SET_LIMITED_INFORMATION アクセス権が必要です。
lpThreadDescriptionLPCWSTRinスレッドの説明を指定する Unicode 文字列です。

戻り値の型: HRESULT

公式ドキュメント

スレッドに説明を割り当てます。

戻り値

関数が成功した場合、戻り値は処理の成功を示す HRESULT です。 関数が失敗した場合、戻り値はエラーを示す HRESULT です。

解説(Remarks)

スレッドの説明は複数回設定でき、最後に設定された値が使用されます。スレッドの説明は GetThreadDescription を呼び出すことで取得できます。

Windows Server 2016Windows 10 LTSB 2016、および Windows 10 version 1607: SetThreadDescription は KernelBase.dll 内で 実行時の動的リンク によってのみ利用できます。

次の例では、現在のスレッドの説明を simulation_thread に設定します。

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

各言語での呼び出し定義

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

HRESULT SetThreadDescription(
    HANDLE hThread,
    LPCWSTR lpThreadDescription
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern int SetThreadDescription(
    IntPtr hThread,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string lpThreadDescription   // LPCWSTR
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function SetThreadDescription(
    hThread As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> lpThreadDescription As String   ' LPCWSTR
) As Integer
End Function
' hThread : HANDLE
' lpThreadDescription : LPCWSTR
Declare PtrSafe Function SetThreadDescription Lib "kernel32" ( _
    ByVal hThread As LongPtr, _
    ByVal lpThreadDescription As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetThreadDescription = ctypes.windll.kernel32.SetThreadDescription
SetThreadDescription.restype = ctypes.c_int
SetThreadDescription.argtypes = [
    wintypes.HANDLE,  # hThread : HANDLE
    wintypes.LPCWSTR,  # lpThreadDescription : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetThreadDescription = Fiddle::Function.new(
  lib['SetThreadDescription'],
  [
    Fiddle::TYPE_VOIDP,  # hThread : HANDLE
    Fiddle::TYPE_VOIDP,  # lpThreadDescription : LPCWSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetThreadDescription(
        hThread: *mut core::ffi::c_void,  // HANDLE
        lpThreadDescription: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern int SetThreadDescription(IntPtr hThread, [MarshalAs(UnmanagedType.LPWStr)] string lpThreadDescription);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetThreadDescription' -Namespace Win32 -PassThru
# $api::SetThreadDescription(hThread, lpThreadDescription)
#uselib "KERNEL32.dll"
#func global SetThreadDescription "SetThreadDescription" sptr, sptr
; SetThreadDescription hThread, lpThreadDescription   ; 戻り値は stat
; hThread : HANDLE -> "sptr"
; lpThreadDescription : LPCWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetThreadDescription "SetThreadDescription" sptr, wstr
; res = SetThreadDescription(hThread, lpThreadDescription)
; hThread : HANDLE -> "sptr"
; lpThreadDescription : LPCWSTR -> "wstr"
; HRESULT SetThreadDescription(HANDLE hThread, LPCWSTR lpThreadDescription)
#uselib "KERNEL32.dll"
#cfunc global SetThreadDescription "SetThreadDescription" intptr, wstr
; res = SetThreadDescription(hThread, lpThreadDescription)
; hThread : HANDLE -> "intptr"
; lpThreadDescription : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetThreadDescription = kernel32.NewProc("SetThreadDescription")
)

// hThread (HANDLE), lpThreadDescription (LPCWSTR)
r1, _, err := procSetThreadDescription.Call(
	uintptr(hThread),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpThreadDescription))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SetThreadDescription(
  hThread: THandle;   // HANDLE
  lpThreadDescription: PWideChar   // LPCWSTR
): Integer; stdcall;
  external 'KERNEL32.dll' name 'SetThreadDescription';
result := DllCall("KERNEL32\SetThreadDescription"
    , "Ptr", hThread   ; HANDLE
    , "WStr", lpThreadDescription   ; LPCWSTR
    , "Int")   ; return: HRESULT
●SetThreadDescription(hThread, lpThreadDescription) = DLL("KERNEL32.dll", "int SetThreadDescription(void*, char*)")
# 呼び出し: SetThreadDescription(hThread, lpThreadDescription)
# hThread : HANDLE -> "void*"
# lpThreadDescription : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SetThreadDescriptionNative = Int32 Function(Pointer<Void>, Pointer<Utf16>);
typedef SetThreadDescriptionDart = int Function(Pointer<Void>, Pointer<Utf16>);
final SetThreadDescription = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetThreadDescriptionNative, SetThreadDescriptionDart>('SetThreadDescription');
// hThread : HANDLE -> Pointer<Void>
// lpThreadDescription : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetThreadDescription(
  hThread: THandle;   // HANDLE
  lpThreadDescription: PWideChar   // LPCWSTR
): Integer; stdcall;
  external 'KERNEL32.dll' name 'SetThreadDescription';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetThreadDescription"
  c_SetThreadDescription :: Ptr () -> CWString -> IO Int32
-- hThread : HANDLE -> Ptr ()
-- lpThreadDescription : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("SetThreadDescription" set-thread-description :convention :stdcall) :int32
  (h-thread :pointer)   ; HANDLE
  (lp-thread-description (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetThreadDescription = Win32::API::More->new('KERNEL32',
    'int SetThreadDescription(HANDLE hThread, LPCWSTR lpThreadDescription)');
# my $ret = $SetThreadDescription->Call($hThread, $lpThreadDescription);
# hThread : HANDLE -> HANDLE
# lpThreadDescription : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。