Share via

getThreadDescription 函式 (processthreadsapi.h)

  • 發行項

藉由呼叫 SetThreadDescription擷取指派給執行緒的描述。

語法

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

參數

[in] hThread

要擷取描述之執行緒的控制碼。 控制碼必須具有THREAD_QUERY_LIMITED_INFORMATION存取權。

[out] ppszThreadDescription

包含執行緒描述的 Unicode 字串。

傳回值

如果函式成功，則傳回值為表示成功作業的 HRESULT 。 如果函式失敗，則傳回值是表示錯誤的 HRESULT 。

備註

Windows Server 2016，Windows 10 LTSB 2016和Windows 10 1607版：GetThreadDescription 僅適用于 KernelBase.dll 中的執行時間動態連結。

執行緒的描述可以隨時變更。 例如，當您嘗試擷取該描述時，不同的執行緒可以變更感興趣的執行緒描述。

執行緒描述不需要是唯一的。

若要釋放執行緒描述的記憶體，請呼叫 LocalFree 方法。

範例

下列範例會取得執行緒的描述、列印描述，然後釋放描述的記憶體。

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

需求

   
最低支援的用戶端 Windows 10 1607 版 [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows Server 2016 [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 processthreadsapi.h
程式庫 Kernel32.lib
DLL Kernel32.dll

另請參閱

LocalFree、 SetThreadDescription