Função SetThreadDescription (processthreadsapi.h)

Atribui uma descrição a um thread.

Sintaxe

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

Parâmetros

[in] hThread

Um identificador para o thread para o qual você deseja definir a descrição. O identificador deve ter acesso THREAD_SET_LIMITED_INFORMATION.

[in] lpThreadDescription

Uma cadeia de caracteres Unicode que especifica a descrição do thread.

Retornar valor

Se a função for bem-sucedida, o valor retornado será o HRESULT que indica uma operação bem-sucedida. Se a função falhar, o valor retornado será um HRESULT que indica o erro.

Comentários

A descrição de um thread pode ser definida mais de uma vez; o valor definido mais recentemente é usado. Você pode recuperar a descrição de um thread chamando GetThreadDescription.

Windows Server 2016, Windows 10 LTSB 2016 e Windows 10 versão 1607: SetThreadDescription só está disponível pela Vinculação Dinâmica em Tempo de Execução no KernelBase.dll.

Exemplos

O exemplo a seguir define a descrição do thread atual como simulation_thread.

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

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 10, versão 1607 [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2016 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	processthreadsapi.h
Biblioteca	Kernel32.lib
DLL	Kernel32.dll

Confira também

GetThreadDescription, Como definir um nome de thread no código nativo