Fungsi GetThreadDescription (processthreadsapi.h)

Artikel
03/08/2023

Mengambil deskripsi yang ditetapkan ke utas dengan memanggil SetThreadDescription.

Sintaks

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

Parameter

[in] hThread

Handel ke utas untuk mengambil deskripsi. Handel harus memiliki akses THREAD_QUERY_LIMITED_INFORMATION.

[out] ppszThreadDescription

String Unicode yang berisi deskripsi utas.

Menampilkan 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

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

Deskripsi untuk utas dapat berubah kapan saja. Misalnya, utas yang berbeda dapat mengubah deskripsi utas yang menarik saat Anda mencoba mengambil deskripsi tersebut.

Deskripsi utas tidak perlu unik.

Untuk membebaskan memori untuk deskripsi utas, panggil metode LocalFree .

Contoh

Contoh berikut mendapatkan deskripsi untuk utas, mencetak deskripsi, lalu membebaskan memori untuk deskripsi.

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

Persyaratan


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

LocalFree, SetThreadDescription

Share via