SetThreadDescription, fonction (processthreadsapi.h)

Affecte une description à un thread.

Syntaxe

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

Paramètres

[in] hThread

Handle pour le thread pour lequel vous souhaitez définir la description. Le handle doit disposer d’un accès THREAD_SET_LIMITED_INFORMATION.

[in] lpThreadDescription

Chaîne Unicode qui spécifie la description du thread.

Valeur retournée

Si la fonction réussit, la valeur de retour est le HRESULT qui désigne une opération réussie. Si la fonction échoue, la valeur de retour est un HRESULT qui désigne l’erreur.

Remarques

La description d’un thread peut être définie plusieurs fois ; la dernière valeur définie est utilisée. Vous pouvez récupérer la description d’un thread en appelant GetThreadDescription.

Windows Server 2016, Windows 10 LTSB 2016 et Windows 10 version 1607 : SetThreadDescription n’est disponible que par liaison dynamique au moment de l’exécution dans KernelBase.dll.

Exemples

L’exemple suivant définit la description du thread actif sur simulation_thread.

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

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 10, version 1607 [applications de bureau | Applications UWP]
Serveur minimal pris en charge	Windows Server 2016 [applications de bureau | Applications UWP]
Plateforme cible	Windows
En-tête	processthreadsapi.h
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll

Voir aussi

GetThreadDescription, Guide pratique pour définir un nom de thread dans le code natif