Represents an exception that contains multiple inner exceptions. More...

#include <aggregate_exception.h>

Public Member Functions
SharedPtr< Collections::ObjectModel::ReadOnlyCollection< Exception > >	get_InnerExceptions ()
	Gets a read-only collection of the inner exceptions. More...

String	get_Message () const override
	Overrides the base message to include aggregated information from all inner exceptions. More...

int32_t	get_InnerExceptionCount ()
	Gets the number of inner exceptions contained in this aggregate exception. More...

const ArrayPtr< Exception > &	get_InternalInnerExceptions ()
	Returns the internal array of inner exceptions. More...

Exception	GetBaseException () const override
	Returns the root cause exception by recursively unwrapping inner exceptions. More...

void	Handle (const Func< Exception, bool > &predicate)
	Invokes a handler function on each inner exception and rethrows any unhandled exceptions. More...

AggregateException	Flatten ()
	Flattens the aggregate exception by unwrapping all nested AggregateExceptions into a single-level list. More...

String	ToString () const override
	Returns a string representation of the exception, including all inner exceptions. More...

Public Member Functions inherited from System::Details_Exception
virtual String	get_Message () const
	Returns the string containing the error destcription. More...

virtual String	get_StackTrace () const
	Returns the string containing the stack trace. More...

virtual ExceptionWrapper< Details_Exception >	get_InnerException () const
	Returns a reference to the object representing the inner exception. More...

virtual ExceptionWrapper< Details_Exception >	GetBaseException () const
	Returns the copy of Exception object representing the inner-most exception. More...

int32_t	get_HResult () const
	Returns a 32-bit integer value which is a HRESULT code associated with the exception reprsented by the current object. More...

void	set_HResult (int32_t value)
	Sets HRESULT, a coded numerical value that is assigned to a specific exception. More...

virtual String	ToString () const override
	Returns the string representation of the current object. More...

virtual const char *	what () const noexcept
	Implements what() method which is called by ExceptionWrapper class. Despite of the fact that this class is not inherited from std::exception derived classes can use protected/private members to implement their logic. Moving this method implementation to the ExceptionWrapper may broke that logic. More...

virtual void	DoThrow (const ExceptionPtr &self) const
	Throws exception instance wrapped by exception wrapper. More...

Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures. More...

virtual	~Object ()
	Destroys object. Frees all internal data structures. More...

	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

Protected Member Functions
void	DoThrow (const ExceptionPtr &self) const override
	Throws this exception instance. More...

	Details_AggregateException ()
	Default constructor. More...

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (Details_AggregateException, CODEPORTING_ARGS())

	Details_AggregateException (const String &message)
	Constructs an aggregate exception with a custom message. More...

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (Details_AggregateException, CODEPORTING_ARGS(const String &message))

	Details_AggregateException (const String &message, Exception innerException)
	Constructs an aggregate exception with a message and a single inner exception. More...

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (Details_AggregateException, CODEPORTING_ARGS(const String &message, const Exception &innerException))

	Details_AggregateException (const SharedPtr< Collections::Generic::IEnumerable< Exception > > &innerExceptions)
	Constructs an aggregate exception from a collection of inner exceptions. More...

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (Details_AggregateException, CODEPORTING_ARGS(const SharedPtr< Collections::Generic::IEnumerable< Exception > > &innerExceptions))

	Details_AggregateException (const ArrayPtr< Exception > &innerExceptions)
	Constructs an aggregate exception from an array of inner exceptions. More...

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (Details_AggregateException, CODEPORTING_ARGS(const ArrayPtr< Exception > &innerExceptions))

	Details_AggregateException (const String &message, const SharedPtr< Collections::Generic::IEnumerable< Exception > > &innerExceptions)
	Constructs an aggregate exception with a message and a collection of inner exceptions. More...

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (Details_AggregateException, CODEPORTING_ARGS(const String &message, const SharedPtr< Collections::Generic::IEnumerable< Exception > > &innerExceptions))

	Details_AggregateException (const String &message, const ArrayPtr< Exception > &innerExceptions)
	Constructs an aggregate exception with a message and an array of inner exceptions. More...

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (Details_AggregateException, CODEPORTING_ARGS(const String &message, const ArrayPtr< Exception > &innerExceptions))

	Details_AggregateException (const String &message, const ArrayPtr< Exception > &innerExceptions, bool cloneExceptions)
	Constructs an aggregate exception with options to clone inner exceptions. More...

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (Details_AggregateException, CODEPORTING_ARGS(const String &message, const ArrayPtr< Exception > &innerExceptions, bool cloneExceptions))

virtual	~Details_AggregateException ()
	Virtual destructor. More...

Protected Member Functions inherited from System::Details_Exception
	Details_Exception ()
	Constructs an instance of Exception class. More...

	Details_Exception (const String &message)
	Constructs an instance of Exception class and assigns the specified error message to it. More...

	Details_Exception (const String &message, const ExceptionWrapper< Details_Exception > &innerException)
	Constructs an instance of Exception class and assigns the specified error message and a reference to the inner exception object. More...

	Details_Exception (const System::SharedPtr< System::Runtime::Serialization::SerializationInfo > &info, System::Runtime::Serialization::StreamingContext context)
	Deserializes exception. More...

virtual String	ExtraDescription () const
	Returns a string containing additional description of the exception. More...

String	DefaultMessage () const
	Returns a default description of the exception based on type. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

Protected Attributes inherited from System::Details_Exception
String	m_message
	The error description. More...

System::ExceptionWrapper< Details_Exception >	m_innerexception
	The Exception object representing the inner exception. More...

std::string	m_std_message
	A string describing the std::exception portion of the current object. More...

int32_t	m_HResult
	HRESULT code associated with the exception represented by the current object. More...

Detailed Description

Represents an exception that contains multiple inner exceptions.

This class is typically used to group several exceptions that occur concurrently, such as in parallel processing or asynchronous task execution scenarios. It allows users to examine, flatten, or selectively handle the contained exceptions.

Constructor & Destructor Documentation

◆ Details_AggregateException() [1/8]

System::Details_AggregateException::Details_AggregateException ( )

protected

Default constructor.

◆ Details_AggregateException() [2/8]

System::Details_AggregateException::Details_AggregateException ( const String & message )

protected

Constructs an aggregate exception with a custom message.

Parameters

message The error message associated with this exception.

◆ Details_AggregateException() [3/8]

System::Details_AggregateException::Details_AggregateException	(	const String &	message,
		Exception	innerException
	)

protected

Constructs an aggregate exception with a message and a single inner exception.

Parameters

message	The error message.
innerException	The inner exception to wrap.

◆ Details_AggregateException() [4/8]

System::Details_AggregateException::Details_AggregateException ( const SharedPtr< Collections::Generic::IEnumerable< Exception > > & innerExceptions )

protected

Constructs an aggregate exception from a collection of inner exceptions.

Parameters

innerExceptions A shared pointer to an IEnumerable of Exception objects.

◆ Details_AggregateException() [5/8]

System::Details_AggregateException::Details_AggregateException ( const ArrayPtr< Exception > & innerExceptions )

protected

Constructs an aggregate exception from an array of inner exceptions.

Parameters

innerExceptions An array of Exception objects.

◆ Details_AggregateException() [6/8]

System::Details_AggregateException::Details_AggregateException	(	const String &	message,
		const SharedPtr< Collections::Generic::IEnumerable< Exception > > &	innerExceptions
	)

protected

Constructs an aggregate exception with a message and a collection of inner exceptions.

Parameters

message	The error message.
innerExceptions	A shared pointer to an IEnumerable of Exception objects.

◆ Details_AggregateException() [7/8]

System::Details_AggregateException::Details_AggregateException	(	const String &	message,
		const ArrayPtr< Exception > &	innerExceptions
	)

protected

Constructs an aggregate exception with a message and an array of inner exceptions.

Parameters

message	The error message.
innerExceptions	An array of Exception objects.

◆ Details_AggregateException() [8/8]

System::Details_AggregateException::Details_AggregateException	(	const String &	message,
		const ArrayPtr< Exception > &	innerExceptions,
		bool	cloneExceptions
	)

protected

Constructs an aggregate exception with options to clone inner exceptions.

Parameters

message	The error message.
innerExceptions	An array of Exception objects.
cloneExceptions	If true, the provided exceptions are deep-copied; otherwise, they are referenced directly.

◆ ~Details_AggregateException()

virtual System::Details_AggregateException::~Details_AggregateException ( )

protectedvirtual

Virtual destructor.

Member Function Documentation

◆ DoThrow()

void System::Details_AggregateException::DoThrow ( const ExceptionPtr & self ) const

overrideprotectedvirtual

Throws this exception instance.

Parameters

self	A shared pointer to this exception.

Remarks: This function is marked [[noreturn]] and is used internally for exception propagation.

Reimplemented from System::Details_Exception.

◆ Flatten()

AggregateException System::Details_AggregateException::Flatten ( )

Flattens the aggregate exception by unwrapping all nested AggregateExceptions into a single-level list.

Returns: A new AggregateException containing all non-aggregate inner exceptions from the entire hierarchy.

◆ get_InnerExceptionCount()

int32_t System::Details_AggregateException::get_InnerExceptionCount ( )

Gets the number of inner exceptions contained in this aggregate exception.

Returns: The count of inner exceptions.

◆ get_InnerExceptions()

SharedPtr< Collections::ObjectModel::ReadOnlyCollection< Exception > > System::Details_AggregateException::get_InnerExceptions ( )

Gets a read-only collection of the inner exceptions.

Returns: A shared pointer to a read-only collection of Exception objects.

◆ get_InternalInnerExceptions()

const ArrayPtr< Exception > & System::Details_AggregateException::get_InternalInnerExceptions ( )

inline

Returns the internal array of inner exceptions.

Returns: An ArrayPtr containing Exception objects.

◆ get_Message()

String System::Details_AggregateException::get_Message ( ) const

overridevirtual

Overrides the base message to include aggregated information from all inner exceptions.

Returns: A string representing the composite error message.

Reimplemented from System::Details_Exception.

◆ GetBaseException()

Exception System::Details_AggregateException::GetBaseException ( ) const

overridevirtual

Returns the root cause exception by recursively unwrapping inner exceptions.

Returns: The base (root) exception.

Reimplemented from System::Details_Exception.

◆ Handle()

void System::Details_AggregateException::Handle ( const Func< Exception, bool > & predicate )

Invokes a handler function on each inner exception and rethrows any unhandled exceptions.

Parameters

predicate A function that takes an Exception and returns true if it is handled.

Note: If all exceptions are handled, the method returns normally; otherwise, a new AggregateException containing the unhandled exceptions is thrown.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [1/8]

System::Details_AggregateException::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	Details_AggregateException	,
		CODEPORTING_ARGS()
	)

protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [2/8]

System::Details_AggregateException::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	Details_AggregateException	,
		CODEPORTING_ARGS(const ArrayPtr< Exception > &innerExceptions)
	)

protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [3/8]

System::Details_AggregateException::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	Details_AggregateException	,
		CODEPORTING_ARGS(const SharedPtr< Collections::Generic::IEnumerable< Exception > > &innerExceptions)
	)

protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [4/8]

System::Details_AggregateException::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	Details_AggregateException	,
		CODEPORTING_ARGS(const String &message)
	)

protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [5/8]

System::Details_AggregateException::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	Details_AggregateException	,
		CODEPORTING_ARGS(const String &message, const ArrayPtr< Exception > &innerExceptions)
	)

protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [6/8]

System::Details_AggregateException::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	Details_AggregateException	,
		CODEPORTING_ARGS(const String &message, const ArrayPtr< Exception > &innerExceptions, bool cloneExceptions)
	)

protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [7/8]

System::Details_AggregateException::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	Details_AggregateException	,
		CODEPORTING_ARGS(const String &message, const Exception &innerException)
	)

protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [8/8]

System::Details_AggregateException::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	Details_AggregateException	,
		CODEPORTING_ARGS(const String &message, const SharedPtr< Collections::Generic::IEnumerable< Exception > > &innerExceptions)
	)

protected

◆ ToString()

String System::Details_AggregateException::ToString ( ) const

overridevirtual

Returns a string representation of the exception, including all inner exceptions.

Returns: A detailed string describing the exception and its inner exceptions.

Reimplemented from System::Details_Exception.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Details_AggregateException() [1/8]

◆ Details_AggregateException() [2/8]

◆ Details_AggregateException() [3/8]

◆ Details_AggregateException() [4/8]

◆ Details_AggregateException() [5/8]

◆ Details_AggregateException() [6/8]

◆ Details_AggregateException() [7/8]

◆ Details_AggregateException() [8/8]

◆ ~Details_AggregateException()

Member Function Documentation

◆ DoThrow()

◆ Flatten()

◆ get_InnerExceptionCount()

◆ get_InnerExceptions()

◆ get_InternalInnerExceptions()

◆ get_Message()

◆ GetBaseException()

◆ Handle()

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [1/8]

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [2/8]

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [3/8]

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [4/8]

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [5/8]

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [6/8]

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [7/8]

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [8/8]

◆ ToString()