Функция SetThreadDescription (processthreadsapi.h)

  • Статья

Назначает описание потоку.

Синтаксис

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

Параметры

[in] hThread

Дескриптор для потока, для которого требуется задать описание. Дескриптор должен иметь доступ THREAD_SET_LIMITED_INFORMATION.

[in] lpThreadDescription

Строка Юникода, задающая описание потока.

Возвращаемое значение

Если функция выполняется успешно, возвращается значение HRESULT , обозначающее успешную операцию. Если функция завершается ошибкой, возвращается значение HRESULT , обозначающее ошибку.

Комментарии

Описание потока можно задать несколько раз; Используется последнее заданное значение. Описание потока можно получить, вызвав Метод GetThreadDescription.

Windows Server 2016, Windows 10 LTSB 2016 и Windows 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
Header processthreadsapi.h
Библиотека Kernel32.lib
DLL Kernel32.dll

См. также

GetThreadDescription, Практическое руководство. Установка имени потока в машинном коде