Função GetThreadDescription (processthreadsapi.h)

Recupera a descrição atribuída a um thread chamando SetThreadDescription.

Sintaxe

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

Parâmetros

[in] hThread

Um identificador para o thread para o qual recuperar a descrição. O identificador deve ter acesso THREAD_QUERY_LIMITED_INFORMATION.

[out] ppszThreadDescription

Uma cadeia de caracteres Unicode que contém a descrição do thread.

Valor retornado

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

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

A descrição de um thread pode ser alterada a qualquer momento. Por exemplo, um thread diferente pode alterar a descrição de um thread de interesse enquanto você tenta recuperar essa descrição.

As descrições de thread não precisam ser exclusivas.

Para liberar a memória para a descrição do thread, chame o método LocalFree .

Exemplos

O exemplo a seguir obtém a descrição de um thread, imprime a descrição e libera a memória para a descrição.

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

Requisitos

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

LocalFree, SetThreadDescription