Función SetThreadDescription (processthreadsapi.h)

Asigna una descripción a un subproceso.

Sintaxis

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

Parámetros

[in] hThread

Identificador del subproceso para el que desea establecer la descripción. El identificador debe tener acceso THREAD_SET_LIMITED_INFORMATION.

[in] lpThreadDescription

Cadena Unicode que especifica 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 VALOR HRESULT que indica el error.

Comentarios

La descripción de un subproceso se puede establecer más de una vez; se usa el valor establecido más recientemente. Puede recuperar la descripción de un subproceso llamando a GetThreadDescription.

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

Ejemplos

En el ejemplo siguiente se establece la descripción del subproceso actual en simulation_thread.

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

Requisitos

Requisito	Value
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

GetThreadDescription, Cómo: Establecer un nombre de subproceso en código nativo