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

Извлекает описание, назначенное потоку путем вызова SetThreadDescription.

Синтаксис

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

Параметры

[in] hThread

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

[out] ppszThreadDescription

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

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

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

Комментарии

Windows Server 2016, Windows 10 LTSB 2016 и Windows 10 версии 1607: GetThreadDescription доступен только в динамической компоновке во время выполнения в KernelBase.dll.

Описание потока может измениться в любое время. Например, другой поток может изменить описание интересующего потока при попытке получить это описание.

Описания потоков не обязательно должны быть уникальными.

Чтобы освободить память для описания потока, вызовите метод LocalFree .

Примеры

В следующем примере возвращается описание для потока, выводится описание, а затем освобождается память для описания.

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

Требования

См. также

LocalFree, SetThreadDescription