Inheritance diagram for xtd::exception:

Definition

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

Namespace: xtd

Library: xtd.core

Examples: format_exception.cpp.

Public Aliases
using	exception_ref
	Optional reference wrapper on std::exception.

Public Constructors
	exception (const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class exception.
	exception (const xtd::optional< xtd::string > &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class exception.
template<typename exception_t>
	exception (const xtd::optional< xtd::string > &message, const exception_t &inner_exception, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class exception.

Public Properties
virtual auto	help_link () const noexcept -> const xtd::string &
	Gets a link to the help file associated with this exception.
virtual auto	help_link (const xtd::string &value) noexcept -> void
	Sets a link to the help file associated with this exception.
virtual auto	h_result () const noexcept -> xtd::int32
	Gets HRESULT, a coded numerical value that is assigned to a specific exception.
virtual auto	h_result (xtd::int32 value) noexcept -> void
	Sets HRESULT, a coded numerical value that is assigned to a specific exception.
virtual auto	error_code () const noexcept -> const std::error_code &
	Gets error associate to the exception.
virtual auto	error_code (const std::error_code &value) noexcept -> void
	Sets error associate to the exception.
virtual auto	inner_exception () const noexcept -> exception_ref
	Gets the exception instance that caused the current exception.
virtual auto	message () const noexcept -> const xtd::string &
	Gets message associate to the exception.
virtual auto	source () const noexcept -> const xtd::string &
	Gets the name of the application or the object that causes the error.
virtual auto	source (const xtd::string &value) noexcept -> void
	Sets the name of the application or the object that causes the error.
virtual auto	stack_trace () const noexcept -> xtd::string
	Gets a string representation of the immediate frames on the call stack.

Public Methods
virtual auto	get_last_stack_frame () const noexcept -> const xtd::diagnostics::stack_frame &
	Gets the last stack frame where the exception occurred.
auto	to_string () const noexcept -> xtd::string override
	Returns a string that represents the current exception.
auto	what () const noexcept -> const char *override
	Gets message associate to the exception.

Public Static Methods
static auto	enable_stack_trace () noexcept -> bool
	Gets if the generation of the stack trace is enabled.
static auto	enable_stack_trace (bool enable) noexcept -> void
	Sets if the generation of the stack trace is enabled. @paran enable triue if stack trace enabled; otherwise false.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	equals (const object &obj) const noexcept -> bool
	Determines whether the specified object is equal to the current object.
virtual auto	get_hash_code () const noexcept -> xtd::usize
	Serves as a hash function for a particular type.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.

Member Typedef Documentation

◆ exception_ref

using xtd::exception::exception_ref

Optional reference wrapper on std::exception.

Constructor & Destructor Documentation

◆ exception() [1/3]

xtd::exception::exception ( const xtd::diagnostics::stack_frame & stack_frame = xtd::diagnostics::stack_frame::current() )

explicit

Create a new instance of class exception.

Parameters

stack_frame (optional) Contains current stack frame about member name, file path and line number in the file where the exception is occurred. Typically xtd::diagnostics::stack_frame::current().

Remarks: Message is set with the default message associate to the exception.

◆ exception() [2/3]

xtd::exception::exception	(	const xtd::optional< xtd::string > &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = xtd::diagnostics::stack_frame::current() )

explicit

Create a new instance of class exception.

Parameters

message	Message string associate to the exception.
stack_frame	(optional) Contains current stack frame about member name, file path and line number in the file where the exception is occurred. Typically xtd::diagnostics::stack_frame::current().

◆ exception() [3/3]

template<typename exception_t>

xtd::exception::exception	(	const xtd::optional< xtd::string > &	message,
		const exception_t &	inner_exception,
		const xtd::diagnostics::stack_frame &	stack_frame = xtd::diagnostics::stack_frame::current() )

inline

Create a new instance of class exception.

Parameters

message	Message string associate to the exception.
inner_exception	The exception that is the cause of the current exception.
stack_frame	(optional) Contains current stack frame about member name, file path and line number in the file where the exception is occurred. Typically xtd::diagnostics::stack_frame::current().

Member Function Documentation

◆ help_link() [1/2]

virtual auto xtd::exception::help_link ( ) const -> const xtd::string &

nodiscardvirtualnoexcept

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

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

◆ help_link() [2/2]

virtual auto xtd::exception::help_link ( const xtd::string & value ) -> void

virtualnoexcept

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

Parameters

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

◆ h_result() [1/2]

virtual auto xtd::exception::h_result ( ) const -> xtd::int32

nodiscardvirtualnoexcept

Gets HRESULT, a coded numerical value that is assigned to a specific exception.

Returns: The HRESULT value.

◆ h_result() [2/2]

virtual auto xtd::exception::h_result ( xtd::int32 value ) -> void

virtualnoexcept

Sets HRESULT, a coded numerical value that is assigned to a specific exception.

Parameters

value The HRESULT value.

◆ error_code() [1/2]

virtual auto xtd::exception::error_code ( ) const -> const std::error_code &

nodiscardvirtualnoexcept

Gets error associate to the exception.

Returns: An error_code represent a Error associate to the exception

◆ error_code() [2/2]

virtual auto xtd::exception::error_code ( const std::error_code & value ) -> void

virtualnoexcept

Sets error associate to the exception.

Parameters

value An error_code represent a Error associate to the exception

◆ inner_exception()

virtual auto xtd::exception::inner_exception ( ) const -> exception_ref

nodiscardvirtualnoexcept

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.

◆ message()

virtual auto xtd::exception::message ( ) const -> const xtd::string &

nodiscardvirtualnoexcept

Gets message associate to the exception.

Returns: A string represent a massage associate to the exception

Reimplemented in xtd::io::file_not_found_exception.

◆ source() [1/2]

virtual auto xtd::exception::source ( ) const -> const xtd::string &

nodiscardvirtualnoexcept

Gets the name of the application or the object that causes the error.

Returns: The name of the application or the object that causes the error.

Remarks: If the xtd::exception::source property is not set explicitly, the runtime automatically sets it to the name of the assembly in which the exception originated.

◆ source() [2/2]

virtual auto xtd::exception::source ( const xtd::string & value ) -> void

virtualnoexcept

Sets the name of the application or the object that causes the error.

Returns: The name of the application or the object that causes the error.

Remarks: If the xtd::exception::source property is not set explicitly, the runtime automatically sets it to the name of the assembly in which the exception originated.

◆ stack_trace()

virtual auto xtd::exception::stack_trace ( ) const -> xtd::string

nodiscardvirtualnoexcept

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

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

◆ get_last_stack_frame()

virtual auto xtd::exception::get_last_stack_frame ( ) const -> const xtd::diagnostics::stack_frame &

nodiscardvirtualnoexcept

Gets the last stack frame where the exception occurred.

Returns: The last stack frame where exception occurred

◆ to_string()

auto xtd::exception::to_string ( ) const -> xtd::string

nodiscardoverridevirtualnoexcept

Returns a string that represents the current exception.

Returns: A string that represents the current exception.

Reimplemented from xtd::object.

◆ what()

auto xtd::exception::what ( ) const -> const char *override

nodiscardoverridenoexcept

Gets message associate to the exception.

Returns: A string represent a massage associate to the exception

◆ enable_stack_trace() [1/2]

auto xtd::exception::enable_stack_trace ( ) -> bool

staticnodiscardnoexcept

Gets if the generation of the stack trace is enabled.

Returns: triue if stack trace enabled; otherwise false.

◆ enable_stack_trace() [2/2]

auto xtd::exception::enable_stack_trace ( bool enable ) -> void

staticnoexcept

Sets if the generation of the stack trace is enabled. @paran enable triue if stack trace enabled; otherwise false.

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

xtd.core/include/xtd/exception.hpp

Definition

Public Aliases

Public Constructors

Public Properties

Public Methods

Public Static Methods

Additional Inherited Members

Member Typedef Documentation

◆ exception_ref

Constructor & Destructor Documentation

◆ exception() [1/3]

◆ exception() [2/3]

◆ exception() [3/3]

Member Function Documentation

◆ help_link() [1/2]

◆ help_link() [2/2]

◆ h_result() [1/2]

◆ h_result() [2/2]

◆ error_code() [1/2]

◆ error_code() [2/2]

◆ inner_exception()

◆ message()

◆ source() [1/2]

◆ source() [2/2]

◆ stack_trace()

◆ get_last_stack_frame()

◆ to_string()

◆ what()

◆ enable_stack_trace() [1/2]

◆ enable_stack_trace() [2/2]