SetThreadDescription-Funktion (processthreadsapi.h)

Artikel
03/13/2024

Weist einem Thread eine Beschreibung zu.

Syntax

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

Parameter

[in] hThread

Ein Handle für den Thread, für den Sie die Beschreibung festlegen möchten. Das Handle muss über THREAD_SET_LIMITED_INFORMATION Zugriff verfügen.

[in] lpThreadDescription

Eine Unicode-Zeichenfolge, die die Beschreibung des Threads angibt.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert der HRESULT , der einen erfolgreichen Vorgang angibt. Wenn die Funktion fehlschlägt, ist der Rückgabewert ein HRESULT , das den Fehler angibt.

Hinweise

Die Beschreibung eines Threads kann mehrmals festgelegt werden. Der zuletzt festgelegte Wert wird verwendet. Sie können die Beschreibung eines Threads abrufen, indem Sie GetThreadDescription aufrufen.

Windows Server 2016, Windows 10 LTSB 2016 und Windows 10 Version 1607: SetThreadDescription ist nur durch dynamische Laufzeitverknüpfung in KernelBase.dll verfügbar.

Beispiele

Im folgenden Beispiel wird die Beschreibung für den aktuellen Thread auf simulation_threadfestgelegt.

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

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 10, Version 1607 [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2016 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	processthreadsapi.h
Bibliothek	Kernel32.lib
DLL	Kernel32.dll

Siehe auch

GetThreadDescription, Vorgehensweise: Festlegen eines Threadnamens in nativem Code

Freigeben über