util::thread_description get_thread_description(
    const pika::threads::thread_id_type& id,
    pika::error_code& ec = throws)

Description

//////////////////////////////////////////////////////////////////////// The function get_thread_description is part of the thread related API allows to query the description of one of the threads known to the thread-manager.

Declared at: libs/pika/threading_base/include/pika/threading_base/thread_description.hpp:282

Parameters

const pika::threads::thread_id_type& id

[in] The thread id of the thread being queried.

pika::error_code& ec = throws

[in,out] this represents the error status on exit, if this is pre-initialized to \athe function will throw on error instead.

Returns

This function returns the description of the thread referenced by the \aparameter. If the thread is not known to the thread-manager the return value will be the string " <unknown >".