Namespaces
Variants

cpp/error/current exception: Difference between revisions

From cppreference.com
Alanf (talk | contribs)
m added period.
Space Mission (talk | contribs)
m Notes: +FMT: P3068.
 
(12 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{cpp/title|current_exception}}
{{cpp/title|current_exception}}
{{cpp/error/navbar}}
{{cpp/error/navbar}}
{{ddcl | header=exception | since=c++11 |
{{|header=exception|since=c++11|
std::exception_ptr current_exception();
std::exception_ptr current_exception() ;
}}
}}


If called during exception handling (typically, in a {{c|catch}} clause), captures the current exception object and creates an {{lc|std::exception_ptr}} that holds either a copy or a reference to that exception object (depending on the implementation).
If called during exception handling (typically, in a {{c|catch}} clause), captures the current exception object and creates an {{lc|std::exception_ptr}} that holds either a copy or a reference to that exception object (depending on the implementation).


If the implementation of this function requires a call to {{c|new}} and the call fails, the returned pointer will hold a reference to an instance of {{lc|std::bad_alloc}}.
If the implementation of this function requires a call to {{c|new}} and the call fails, the returned pointer will hold a reference to an instance of {{lc|std::bad_alloc}}.


If the implementation of this function requires copying the captured exception object and its copy constructor throws an exception, the returned pointer will hold a reference to the exception thrown. If the copy constructor of the thrown exception object also throws, the returned pointer may hold a reference to an instance of {{lc|std::bad_exception}} to break the endless loop.
If the implementation of this function requires copying the captured exception object and its copy constructor throws an exception, the returned pointer will hold a reference to the exception thrown. If the copy constructor of the thrown exception object also throws, the returned pointer may hold a reference to an instance of {{lc|std::bad_exception}} to break the endless loop.
Line 13: Line 13:
If the function is called when no exception is being handled, an empty {{lc|std::exception_ptr}} is returned.
If the function is called when no exception is being handled, an empty {{lc|std::exception_ptr}} is returned.


===Parameters===
(none)


===Return value===
===Return value===
An instance of {{lc|std::exception_ptr}} holding a reference to the exception object, or a copy of the exception object, or to an instance of {{lc|std::bad_alloc}} or to an instance of {{lc|std::bad_exception}}.
An instance of {{lc|std::exception_ptr}} holding a reference to the exception object, or a copy of the exception object, or to an instance of {{lc|std::bad_alloc}} or to an instance of {{lc|std::bad_exception}}.


===Exceptions===
======
{{noexcept}}
{{
 
 
 
}}


===Example===
===Example===
{{include| cpp/error/example_exception_ptr}}
{{include|cpp/error/example_exception_ptr}}


===See also===
===See also===
{{dsc begin}}
{{dsc begin}}
{{dsc inc | cpp/error/dsc exception_ptr}}
{{dsc inc|cpp/error/dsc exception_ptr}}
{{dsc inc | cpp/error/dsc rethrow_exception}}
{{dsc inc|cpp/error/dsc rethrow_exception}}
{{dsc inc | cpp/error/dsc make_exception_ptr}}
{{dsc inc|cpp/error/dsc make_exception_ptr
}}
{{dsc end}}
{{dsc end}}


[[de:cpp/error/current exception]]
deesfritjaptruzh
[[es:cpp/error/current exception]]
[[fr:cpp/error/current exception]]
[[it:cpp/error/current exception]]
[[ja:cpp/error/current exception]]
[[pt:cpp/error/current exception]]
[[ru:cpp/error/current exception]]
[[zh:cpp/error/current exception]]

Latest revision as of 20:26, 24 November 2024

 
 
 
Defined in header <exception>
std::exception_ptr current_exception() noexcept;
(since C++11)
(constexpr since C++26)

If called during exception handling (typically, in a catch clause), captures the current exception object and creates an std::exception_ptr that holds either a copy or a reference to that exception object (depending on the implementation). The referenced object remains valid at least as long as there is an exception_ptr object that refers to it.

If the implementation of this function requires a call to new and the call fails, the returned pointer will hold a reference to an instance of std::bad_alloc.

If the implementation of this function requires copying the captured exception object and its copy constructor throws an exception, the returned pointer will hold a reference to the exception thrown. If the copy constructor of the thrown exception object also throws, the returned pointer may hold a reference to an instance of std::bad_exception to break the endless loop.

If the function is called when no exception is being handled, an empty std::exception_ptr is returned.

This function can be called in a std::terminate_handler to retrieve the exception which has provoked the invocation of std::terminate.

Return value

An instance of std::exception_ptr holding a reference to the exception object, or a copy of the exception object, or to an instance of std::bad_alloc or to an instance of std::bad_exception.

Notes

On the implementations that follow Itanium C++ ABI (GCC, Clang, etc), exceptions are allocated on the heap when thrown (except for std::bad_alloc in some cases), and this function simply creates the smart pointer referencing the previously-allocated object, On MSVC, exceptions are allocated on stack when thrown, and this function performs the heap allocation and copies the exception object.

On Windows in managed CLR environments [1], the implementation will store a std::bad_exception when the current exception is a managed exception ([2]). Note that catch(...) catches also managed exceptions:

#include <exception>

int main()
{
    try
    {
        throw gcnew System::Exception("Managed exception");
    }
    catch (...)
    {
        std::exception_ptr ex = std::current_exception();
        try
        {
            std::rethrow_exception(ex);
        }
        catch (std::bad_exception const &)
        {
            // This will be printed.
            std::cout << "Bad exception" << std::endl;
        }
    }
}
Feature-test macro Value Std Feature
__cpp_lib_constexpr_exceptions 202411L (C++26) constexpr for exception types

Example

#include <exception>
#include <iostream>
#include <stdexcept>
#include <string>

void handle_eptr(std::exception_ptr eptr) // passing by value is OK
{
    try
    {
        if (eptr)
            std::rethrow_exception(eptr);
    }
    catch(const std::exception& e)
    {
        std::cout << "Caught exception: '" << e.what() << "'\n";
    }
}

int main()
{
    std::exception_ptr eptr;

    try
    {
        [[maybe_unused]]
        char ch = std::string().at(1); // this generates a std::out_of_range
    }
    catch(...)
    {
        eptr = std::current_exception(); // capture
    }

    handle_eptr(eptr);

} // destructor for std::out_of_range called here, when the eptr is destructed

Possible output:

Caught exception: 'basic_string::at: __n (which is 1) >= this->size() (which is 0)'

See also

shared pointer type for handling exception objects
(typedef) [edit]
throws the exception from an std::exception_ptr
(function) [edit]
creates an std::exception_ptr from an exception object
(function template) [edit]
(removed in C++20*)(C++17)
checks if exception handling is currently in progress
(function) [edit]