Function get

Function get_error

hpx::get_error — Return the locality id where the exception was thrown.

Synopsis

// In header: <hpx/exception.hpp>


error get_error(hpx::exception const & e);

Description

The function hpx::get_error can be used to extract the diagnostic information element representing the error value code as stored in the given exception instance.

See Also:

hpx::diagnostic_information(), hpx::get_error_host_name(), hpx::get_error_process_id(), hpx::get_error_function_name(), hpx::get_error_file_name(), hpx::get_error_line_number(), hpx::get_error_os_thread(), hpx::get_error_thread_id(), hpx::get_error_thread_description(), hpx::get_error_backtrace(), hpx::get_error_env(), hpx::get_error_what(), hpx::get_error_config()

Parameters:

`e`	The parameter `e` will be inspected for the requested diagnostic information elements which have been stored at the point where the exception was thrown. This parameter can be one of the following types: `hpx::exception`, `hpx::error_code`, or boost::exception_ptr.

Returns:

The error value code of the locality where the exception was thrown. If the exception instance does not hold this information, the function will return hpx::naming::invalid_locality_id.

Throws:

nothing