Función GetThreadDescription (processthreadsapi.h)

Recupera la descripción que se asignó a un subproceso mediante una llamada a SetThreadDescription.

Sintaxis

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

Parámetros

[in] hThread

Identificador del subproceso para el que se va a recuperar la descripción. El identificador debe tener acceso THREAD_QUERY_LIMITED_INFORMATION.

[out] ppszThreadDescription

Cadena Unicode que contiene la descripción del subproceso.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es hrESULT que denota una operación correcta. Si se produce un error en la función, el valor devuelto es un HRESULT que indica el error.

Comentarios

Windows Server 2016, Windows 10 LTSB 2016 y Windows 10 versión 1607: GetThreadDescription solo está disponible mediante la vinculación dinámica en tiempo de ejecución en KernelBase.dll.

La descripción de un subproceso puede cambiar en cualquier momento. Por ejemplo, un subproceso diferente puede cambiar la descripción de un subproceso de interés mientras intenta recuperar esa descripción.

Las descripciones de subprocesos no necesitan ser únicas.

Para liberar la memoria de la descripción del subproceso, llame al método LocalFree .

Ejemplos

En el ejemplo siguiente se obtiene la descripción de un subproceso, se imprime la descripción y, a continuación, se libera la memoria de la descripción.

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

Requisitos

Cliente mínimo compatible	Windows 10, versión 1607 [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2016 [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	processthreadsapi.h
Library	Kernel32.lib
Archivo DLL	Kernel32.dll

Vea también

LocalFree, SetThreadDescription