#include <system_exception.h>

Definition

Defines the base class for predefined exceptions in the xtd namespace.

Namespace: xtd

Library: xtd.core

Examples: application_and_exception.cpp, exception_box.cpp, and exception_dialog.cpp.

Inherits xtd::object, and std::exception.

Inherited by xtd::argument_exception, xtd::arithmetic_exception, xtd::collections::key_not_found_exception, xtd::domain_exception, xtd::format_exception, xtd::index_out_of_range_exception, xtd::invalid_cast_exception, xtd::invalid_operation_exception, xtd::invalid_program_exception, xtd::io::io_exception, xtd::length_exception, xtd::net::sockets::socket_exception, xtd::not_implemented_exception, xtd::not_supported_exception, xtd::null_pointer_exception, xtd::object_closed_exception, xtd::operation_canceled_exception, xtd::time_out_exception, and xtd::xml_syntax_exception.

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

Public Member Functions
	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.

	system_exception (const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
	Create a new instance of class system_exception.

	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.

	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.

	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.

	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.

	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.

	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.

	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.

	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.

virtual std::error_code	error_code () const noexcept
	Get error associate to the exception.

virtual const xtd::ustring &	file_path () const noexcept
	Get file path where exception occurred.

virtual const xtd::ustring &	help_link () const noexcept
	Gets a link to the help file associated with this exception.

virtual exception_ref	inner_exception () const noexcept
	Gets the exception instance that caused the current exception.

virtual uint32_t	line_number () const noexcept
	Get Line number where the exception occurred.

virtual const xtd::ustring &	member_name () const noexcept
	Get file member where exception occurred.

virtual const xtd::ustring &	message () const noexcept
	Get message associate to the exception.

virtual const xtd::ustring &	name () const noexcept
	Get full class name the exception.

virtual xtd::ustring	stack_trace () const noexcept
	Gets a string representation of the immediate frames on the call stack.

xtd::ustring	to_string () const noexcept override
	Returns a string that represents the current exception.

const char *	what () const noexcept override
	Get message associate to the exception.

Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.

virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.

virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.

template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const
	Gets the type of the current instance.

virtual xtd::ustring	to_string () const noexcept
	Returns a std::string that represents the current object.

Static Public Member Functions
static bool	enable_stack_trace ()
	Gets or sets if the generation of the stack trace is enabled.

static void	enable_stack_trace (bool enable)

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.

static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance.

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

message	Message 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

message	Message string associate to the exception.
error	Error 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

message	Message string associate to the exception.
help_link	Help 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

message	Message string associate to the exception.
error	Error code associate to the exception.
help_link	Help 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_exception	The 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

message	Message string associate to the exception.
inner_exception	The 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

message	Message string associate to the exception.
inner_exception	The exception that is the cause of the current exception.
error	Error 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

message	Message string associate to the exception.
inner_exception	The exception that is the cause of the current exception.
help_link	Help 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

message	Message string associate to the exception.
inner_exception	The exception that is the cause of the current exception.
error	Error code associate to the exception.
help_link	Help 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 ( )

inlinestatic

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

◆ error_code()

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

inlinevirtualnoexcept

Get 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

inlinevirtualnoexcept

Get 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

inlinevirtualnoexcept

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

inlinevirtualnoexcept

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_t xtd::system_exception::line_number ( ) const

inlinevirtualnoexcept

Get 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

inlinevirtualnoexcept

Get file member where exception occurred.

Returns: A string represent member name where exception occurred

◆ message()

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

inlinevirtualnoexcept

Get message associate to the exception.

Returns: A string represent a massage associate to the exception

◆ name()

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

inlinevirtualnoexcept

Get full class name the exception.

Returns: A string represent a full class name of the exception

◆ stack_trace()

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

inlinevirtualnoexcept

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

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

◆ 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.

◆ what()

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

inlineoverridenoexcept

Get 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:

xtd.core/include/xtd/system_exception.h

Definition

Public Types

Public Member Functions

Static Public Member Functions

Member Typedef Documentation

◆ exception_ref

Constructor & Destructor Documentation

◆ system_exception() [1/10]

◆ system_exception() [2/10]

◆ system_exception() [3/10]

◆ system_exception() [4/10]

◆ system_exception() [5/10]

◆ system_exception() [6/10]

◆ system_exception() [7/10]

◆ system_exception() [8/10]

◆ system_exception() [9/10]

◆ system_exception() [10/10]

Member Function Documentation

◆ enable_stack_trace()

◆ error_code()

◆ file_path()

◆ help_link()

◆ inner_exception()

◆ line_number()

◆ member_name()

◆ message()

◆ name()

◆ stack_trace()

◆ to_string()

◆ what()