SetThreadDescription 函数 (processthreadsapi.h)

为线程分配说明。

语法

HRESULT SetThreadDescription(
  [in] HANDLE hThread,
  [in] PCWSTR lpThreadDescription
);

参数

[in] hThread

要为其设置说明的线程的句柄。 句柄必须具有THREAD_SET_LIMITED_INFORMATION访问权限。

[in] lpThreadDescription

一个 Unicode 字符串,指定线程的说明。

返回值

如果函数成功,则返回值为表示操作成功的 HRESULT 。 如果函数失败,则返回值为表示错误的 HRESULT

注解

可以多次设置线程的说明;使用最近设置的值。 可以通过调用 GetThreadDescription 来检索线程的说明。

Windows Server 2016,Windows 10LTSB 2016Windows 10版本 1607:SetThreadDescription 仅在 KernelBase.dll 中的运行时动态链接可用。

示例

以下示例将当前线程的说明设置为 simulation_thread

HRESULT hr = SetThreadDescription(GetCurrentThread(), L"simulation_thread");
if (FAILED(hr))
{
    // Call failed.
}

要求

要求
最低受支持的客户端 Windows 10版本 1607 [桌面应用 |UWP 应用]
最低受支持的服务器 Windows Server 2016 [桌面应用 |UWP 应用]
目标平台 Windows
标头 processthreadsapi.h
Library Kernel32.lib
DLL Kernel32.dll

另请参阅

GetThreadDescription如何:在本机代码中设置线程名称