getThreadDescription 函数 (processthreadsapi.h)

通过调用 SetThreadDescription 检索分配给线程的说明。

语法

HRESULT GetThreadDescription(
  [in]  HANDLE hThread,
  [out] PWSTR  *ppszThreadDescription
);

parameters

[in] hThread

要检索其说明的线程的句柄。 句柄必须具有THREAD_QUERY_LIMITED_INFORMATION访问权限。

[out] ppszThreadDescription

包含线程说明的 Unicode 字符串。

返回值

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

注解

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

线程的说明可以随时更改。 例如,当你尝试检索该说明时,其他线程可以更改相关线程的说明。

线程说明不需要是唯一的。

若要释放线程说明的内存,请调用 LocalFree 方法。

示例

以下示例获取线程的说明,打印说明,然后释放说明的内存。

HRESULT hr = GetThreadDescription(ThreadHandle, &data);
if (SUCCEEDED(hr))
{   
    wprintf(“%ls\n”, data);
    LocalFree(data);
}

要求

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

另请参阅

LocalFreeSetThreadDescription