pika::error get_error(const pika::exception& e)

Description

Return the error code value of the exception thrown.

The function \acan be used to extract the diagnostic information element representing the error value code as stored in the given exception instance.

Declared at: libs/pika/errors/include/pika/errors/exception.hpp:394

Parameters

const pika::exception& e

The parameter \pwill 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: \a\aor \a

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\a