SetThreadDescription 関数 (processthreadsapi.h)

スレッドに説明を割り当てます。

構文

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

パラメーター

[in] hThread

説明を設定するスレッドのハンドル。 ハンドルにはTHREAD_SET_LIMITED_INFORMATIONアクセス権が必要です。

[in] lpThreadDescription

スレッドの説明を指定する Unicode 文字列。

戻り値

関数が成功した場合、戻り値は正常な操作を示す HRESULT です。 関数が失敗した場合、戻り値はエラーを示す HRESULT です。

注釈

スレッドの説明は複数回設定できます。最後に設定した値が使用されます。 GetThreadDescription を呼び出すと、スレッドの説明を取得できます。

Windows Server 2016WINDOWS 10 LTSB 2016 および Windows 10 バージョン 1607: SetThreadDescription は、KernelBase.dllの実行時動的リンクでのみ使用できます。

次の例では、現在のスレッド simulation_threadの説明を .

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

要件

   
サポートされている最小のクライアント Windows 10、バージョン 1607 [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー Windows Server 2016 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー processthreadsapi.h
Library Kernel32.lib
[DLL] Kernel32.dll

関連項目

GetThreadDescription方法: ネイティブ コードでスレッド名を設定する