xtd 0.2.0
xtd::system_exception Class Reference

Definition

Alias

using exception_ref = std::optional< std::reference_wrapper< const std::exception > >
 Optional reference wrapper on std::exception. More...
 

Constructors

 system_exception (const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const xtd::ustring &message, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const xtd::ustring &message, const std::error_code &error, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const xtd::ustring &message, const xtd::ustring &help_link, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const xtd::ustring &message, const std::error_code &error, const xtd::ustring &help_link, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const std::exception &inner_exception, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const xtd::ustring &message, const std::exception &inner_exception, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const xtd::ustring &message, const std::exception &inner_exception, const std::error_code &error, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const xtd::ustring &message, const std::exception &inner_exception, const xtd::ustring &help_link, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const xtd::ustring &message, const std::exception &inner_exception, const std::error_code &error, const xtd::ustring &help_link, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 

Properties

virtual const xtd::ustringfile_path () const noexcept
 Gets file path where exception occurred. More...
 
virtual const xtd::ustringhelp_link () const noexcept
 Gets a link to the help file associated with this exception. More...
 
virtual std::error_code error_code () const noexcept
 Gets error associate to the exception. More...
 
virtual exception_ref inner_exception () const noexcept
 Gets the exception instance that caused the current exception. More...
 
virtual uint32 line_number () const noexcept
 Gets Line number where the exception occurred. More...
 
virtual const xtd::ustringmember_name () const noexcept
 Gets file member where exception occurred. More...
 
virtual const xtd::ustringmessage () const noexcept
 Gets message associate to the exception. More...
 
virtual const xtd::ustringname () const noexcept
 Gets full class name the exception. More...
 
virtual xtd::ustring stack_trace () const noexcept
 Gets a string representation of the immediate frames on the call stack. More...
 
static bool enable_stack_trace () noexcept
 Gets or sets if the generation of the stack trace is enabled. More...
 
static void enable_stack_trace (bool enable) noexcept
 

Methods

xtd::ustring to_string () const noexcept override
 Returns a string that represents the current exception. More...
 
const char * what () const noexcept override
 Gets message associate to the exception. More...
 

Additional Inherited Members

- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object. More...
 
bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object. More...
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type. More...
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance. More...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const noexcept
 Creates a shallow copy of the current object. More...
 
- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal. More...
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance. More...
 

Member Typedef Documentation

◆ exception_ref

using xtd::system_exception::exception_ref = std::optional<std::reference_wrapper<const std::exception> >

Optional reference wrapper on std::exception.

Constructor & Destructor Documentation

◆ system_exception() [1/10]

xtd::system_exception::system_exception ( const xtd::diagnostics::stack_frame information = xtd::diagnostics::stack_frame::empty())
inlineexplicit

Create a new instance of class system_exception.

Parameters
information(optional) Contains current information about member name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.
Remarks
Message is set with the default message associate to the exception.

◆ system_exception() [2/10]

xtd::system_exception::system_exception ( const xtd::ustring message,
const xtd::diagnostics::stack_frame information = xtd::diagnostics::stack_frame::empty() 
)
inlineexplicit

Create a new instance of class system_exception.

Parameters
messageMessage string associate to the exception.
information(optional) Contains current information about member name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.

◆ system_exception() [3/10]

xtd::system_exception::system_exception ( const xtd::ustring message,
const std::error_code &  error,
const xtd::diagnostics::stack_frame information = xtd::diagnostics::stack_frame::empty() 
)
inline

Create a new instance of class system_exception.

Parameters
messageMessage string associate to the exception.
errorError code associate to the exception.
information(optional) Contains current information about member name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.

◆ system_exception() [4/10]

xtd::system_exception::system_exception ( const xtd::ustring message,
const xtd::ustring help_link,
const xtd::diagnostics::stack_frame information = xtd::diagnostics::stack_frame::empty() 
)
inline

Create a new instance of class system_exception.

Parameters
messageMessage string associate to the exception.
help_linkHelp link string associate to the exception.
information(optional) Contains current information about member name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.

◆ system_exception() [5/10]

xtd::system_exception::system_exception ( const xtd::ustring message,
const std::error_code &  error,
const xtd::ustring help_link,
const xtd::diagnostics::stack_frame information = xtd::diagnostics::stack_frame::empty() 
)
inline

Create a new instance of class system_exception.

Parameters
messageMessage string associate to the exception.
errorError code associate to the exception.
help_linkHelp link string associate to the exception.
information(optional) Contains current information about member name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.

◆ system_exception() [6/10]

xtd::system_exception::system_exception ( const std::exception &  inner_exception,
const xtd::diagnostics::stack_frame information = xtd::diagnostics::stack_frame::empty() 
)
inlineexplicit

Create a new instance of class system_exception.

Parameters
inner_exceptionThe exception that is the cause of the current exception.
information(optional) Contains current information about member name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.
Remarks
Message is set with the default message associate to the exception.

◆ system_exception() [7/10]

xtd::system_exception::system_exception ( const xtd::ustring message,
const std::exception &  inner_exception,
const xtd::diagnostics::stack_frame information = xtd::diagnostics::stack_frame::empty() 
)
inline

Create a new instance of class system_exception.

Parameters
messageMessage string associate to the exception.
inner_exceptionThe exception that is the cause of the current exception.
information(optional) Contains current information about member name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.

◆ system_exception() [8/10]

xtd::system_exception::system_exception ( const xtd::ustring message,
const std::exception &  inner_exception,
const std::error_code &  error,
const xtd::diagnostics::stack_frame information = xtd::diagnostics::stack_frame::empty() 
)
inline

Create a new instance of class system_exception.

Parameters
messageMessage string associate to the exception.
inner_exceptionThe exception that is the cause of the current exception.
errorError code associate to the exception.
information(optional) Contains current information about member name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.

◆ system_exception() [9/10]

xtd::system_exception::system_exception ( const xtd::ustring message,
const std::exception &  inner_exception,
const xtd::ustring help_link,
const xtd::diagnostics::stack_frame information = xtd::diagnostics::stack_frame::empty() 
)
inline

Create a new instance of class system_exception.

Parameters
messageMessage string associate to the exception.
inner_exceptionThe exception that is the cause of the current exception.
help_linkHelp link string associate to the exception.
information(optional) Contains current information about member name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.

◆ system_exception() [10/10]

xtd::system_exception::system_exception ( const xtd::ustring message,
const std::exception &  inner_exception,
const std::error_code &  error,
const xtd::ustring help_link,
const xtd::diagnostics::stack_frame information = xtd::diagnostics::stack_frame::empty() 
)
inline

Create a new instance of class system_exception.

Parameters
messageMessage string associate to the exception.
inner_exceptionThe exception that is the cause of the current exception.
errorError code associate to the exception.
help_linkHelp link string associate to the exception.
information(optional) Contains current information about member name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.

Member Function Documentation

◆ enable_stack_trace()

static bool xtd::system_exception::enable_stack_trace ( )
staticnoexcept

Gets or sets if the generation of the stack trace is enabled.

◆ error_code()

virtual std::error_code xtd::system_exception::error_code ( ) const
virtualnoexcept

Gets error associate to the exception.

Returns
An error_code represent a Error associate to the exception

◆ file_path()

virtual const xtd::ustring& xtd::system_exception::file_path ( ) const
virtualnoexcept

Gets file path where exception occurred.

Returns
A string represent file path where exception occurred

◆ help_link()

virtual const xtd::ustring& xtd::system_exception::help_link ( ) const
virtualnoexcept

Gets a link to the help file associated with this exception.

Returns
A string represent a link to Help file associated with exception

◆ inner_exception()

virtual exception_ref xtd::system_exception::inner_exception ( ) const
virtualnoexcept

Gets the exception instance that caused the current exception.

Returns
An instance of exception that describes the error that caused the current exception. The inner_exception property returns the same value as was passed into the constructor, or a null reference if the inner exception value was not supplied to the constructor.

◆ line_number()

virtual uint32 xtd::system_exception::line_number ( ) const
virtualnoexcept

Gets Line number where the exception occurred.

Returns
the line number where exception occurred

◆ member_name()

virtual const xtd::ustring& xtd::system_exception::member_name ( ) const
virtualnoexcept

Gets file member where exception occurred.

Returns
A string represent member name where exception occurred

◆ message()

virtual const xtd::ustring& xtd::system_exception::message ( ) const
virtualnoexcept

◆ name()

virtual const xtd::ustring& xtd::system_exception::name ( ) const
virtualnoexcept

Gets full class name the exception.

Returns
A string represent a full class name of the exception
Examples:
application_and_exception.cpp.

◆ stack_trace()

virtual xtd::ustring xtd::system_exception::stack_trace ( ) const
virtualnoexcept

Gets a string representation of the immediate frames on the call stack.

Returns
A string that describes the immediate frames of the call stack.
Examples:
file_info_move_to.cpp.

◆ to_string()

xtd::ustring xtd::system_exception::to_string ( ) const
overridevirtualnoexcept

Returns a string that represents the current exception.

Returns
A string that represents the current exception.

Reimplemented from xtd::object.

Examples:
file_info.cpp.

◆ what()

const char* xtd::system_exception::what ( ) const
overridenoexcept

Gets message associate to the exception.

Returns
A string represent a massage associate to the exception

The documentation for this class was generated from the following file: