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
Library Kernel32.lib
[DLL] Kernel32.dll

関連項目

LocalFree、 SetThreadDescription