Fungsi SetThreadDescription (processthreadsapi.h)

Menetapkan deskripsi ke utas.

Sintaks

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

Parameter

[in] hThread

Handel untuk utas yang ingin Anda atur deskripsinya. Handel harus memiliki akses THREAD_SET_LIMITED_INFORMATION.

[in] lpThreadDescription

String Unicode yang menentukan deskripsi utas.

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah HRESULT yang menunjukkan operasi yang berhasil. Jika fungsi gagal, nilai yang dikembalikan adalah HRESULT yang menunjukkan kesalahan.

Keterangan

Deskripsi utas dapat diatur lebih dari sekali; nilai yang terakhir ditetapkan digunakan. Anda dapat mengambil deskripsi utas dengan memanggil GetThreadDescription.

Windows Server 2016, Windows 10 LTSB 2016 dan Windows 10 versi 1607: SetThreadDescription hanya tersedia oleh Run Time Dynamic Linking di KernelBase.dll.

Contoh

Contoh berikut mengatur deskripsi untuk utas saat ini ke simulation_thread.

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

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 10, versi 1607 [aplikasi desktop | Aplikasi UWP]
Server minimum yang didukung	Windows Server 2016 [aplikasi desktop | Aplikasi UWP]
Target Platform	Windows
Header	processthreadsapi.h
Pustaka	Kernel32.lib
DLL	Kernel32.dll

Lihat juga

GetThreadDescription, Cara: Mengatur Nama Utas dalam Kode Asli