Asposecpplib

Represents an exception. Never create instances of this class manually. Use the Exception class instead. Never wrap the Exception class instances into System::SmartPtr. More...

Inherits System::Object.

Inherited by Aspose::Zip::Details_ZipException, Aspose::Zip::Details_ZlibException, System::Details_ApplicationException, System::Details_InvalidOperationException, System::Details_InvalidProgramException, System::Details_InvalidTimeZoneException, System::Details_SystemException, System::Details_TimeZoneNotFoundException, System::Net::Http::Details_HttpRequestException, System::Net::Sockets::Details_SocketException, System::Reflection::Details_ReflectionTypeLoadException, and System::Web::Details_HttpException.

Public Member Functions

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_Exceptionget_InnerException () const
 Returns a reference to the object representing the inner exception. More...
 
virtual ExceptionWrapper< Details_ExceptionGetBaseException () 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...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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 ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () 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

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

Protected Attributes

String m_message
 The error description. More...
 
System::ExceptionWrapper< Details_Exceptionm_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...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 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 TypeInfoType ()
 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...
 

Detailed Description

Represents an exception. Never create instances of this class manually. Use the Exception class instead. Never wrap the Exception class instances into System::SmartPtr.

Constructor & Destructor Documentation

◆ Details_Exception() [1/4]

System::Details_Exception::Details_Exception ( )
protected

Constructs an instance of Exception class.

◆ Details_Exception() [2/4]

System::Details_Exception::Details_Exception ( const String message)
protected

Constructs an instance of Exception class and assigns the specified error message to it.

Parameters
messageString that contains the error destription

◆ Details_Exception() [3/4]

System::Details_Exception::Details_Exception ( const String message,
const ExceptionWrapper< Details_Exception > &  innerException 
)
protected

Constructs an instance of Exception class and assigns the specified error message and a reference to the inner exception object.

Parameters
messageString that contains the error destription
innerExceptionA reference to the exception object interpreted as a cause for the exception represented by the Exception being constructed

◆ Details_Exception() [4/4]

System::Details_Exception::Details_Exception ( const System::SharedPtr< System::Runtime::Serialization::SerializationInfo > &  info,
System::Runtime::Serialization::StreamingContext  context 
)
protected

Deserializes exception.

Parameters
infoSerializationInfo object holding serialized exception.
contextStreaming context bound to serialization info passed.

Member Function Documentation

◆ DefaultMessage()

String System::Details_Exception::DefaultMessage ( ) const
protected

Returns a default description of the exception based on type.

◆ DoThrow()

virtual void System::Details_Exception::DoThrow ( const ExceptionPtr self) const
virtual

Throws exception instance wrapped by exception wrapper.

Parameters
selfException instance to be thrown.

Reimplemented in System::Xml::Schema::Details_XmlSchemaValidationException, System::Xml::Schema::Details_XmlSchemaException, System::Xml::XPath::Details_XPathException, System::Xml::Details_XmlException, System::Text::Details_EncoderFallbackException, System::Text::Details_DecoderFallbackException, System::Runtime::InteropServices::Details_ExternalException, NUnit::Framework::Details_AssertionException, System::Reflection::Details_TargetInvocationException, System::Reflection::Details_ReflectionTypeLoadException, System::Runtime::Serialization::Details_SerializationException, System::Web::Details_HttpException, System::Collections::Generic::Details_KeyNotFoundException, System::ComponentModel::Details_InvalidEnumArgumentException, System::Threading::Details_ThreadInterruptedException, System::Threading::Details_ThreadAbortException, System::Threading::Details_SynchronizationLockException, System::Threading::Details_SemaphoreFullException, System::Threading::Details_ThreadStateException, System::Security::Authentication::Details_AuthenticationException, System::Security::Cryptography::Details_CryptographicUnexpectedOperationException, System::Security::Cryptography::Details_CryptographicException, System::Security::Details_SecurityException, System::Globalization::Details_CultureNotFoundException, System::IO::Details_PathTooLongException, System::IO::Details_FileLoadException, System::IO::Details_DirectoryNotFoundException, System::IO::Details_InvalidDataException, System::IO::Details_EndOfStreamException, System::IO::Details_IOException, System::Details_DataMisalignedException, System::Details_TypeInitializationException, System::Details_ExecutionEngineException, System::Details_TimeoutException, System::Details_StackOverflowException, System::Details_OperationCanceledException, System::Details_MethodAccessException, System::Details_MemberAccessException, System::Details_UnauthorizedAccessException, System::Details_NullReferenceException, System::Details_InvalidCastException, System::Details_RankException, System::Details_IndexOutOfRangeException, System::Details_OutOfMemoryException, System::Details_DivideByZeroException, System::Details_OverflowException, System::Details_ArithmeticException, System::Details_UriFormatException, System::Details_FormatException, System::Details_ArgumentOutOfRangeException, System::Details_ArgumentNullException, System::Details_ArgumentException, System::Details_PlatformNotSupportedException, System::Details_NotSupportedException, System::Details_NotImplementedException, System::Details_ObjectDisposedException, System::Details_TimeZoneNotFoundException, System::Details_InvalidTimeZoneException, System::Details_InvalidProgramException, System::Details_InvalidOperationException, System::Details_ApplicationException, System::Details_SystemException, System::ComponentModel::Details_Win32Exception, System::Details_BadImageFormatException, System::Net::Details_WebException, System::Web::Services::Protocols::Details_SoapException, and System::Net::Sockets::Details_SocketException.

◆ ExtraDescription()

◆ get_HResult()

int32_t System::Details_Exception::get_HResult ( ) const

Returns a 32-bit integer value which is a HRESULT code associated with the exception reprsented by the current object.

◆ get_InnerException()

virtual ExceptionWrapper<Details_Exception> System::Details_Exception::get_InnerException ( ) const
virtual

Returns a reference to the object representing the inner exception.

◆ get_Message()

virtual String System::Details_Exception::get_Message ( ) const
virtual

◆ get_StackTrace()

virtual String System::Details_Exception::get_StackTrace ( ) const
virtual

Returns the string containing the stack trace.

◆ GetBaseException()

virtual ExceptionWrapper<Details_Exception> System::Details_Exception::GetBaseException ( ) const
virtual

Returns the copy of Exception object representing the inner-most exception.

◆ set_HResult()

void System::Details_Exception::set_HResult ( int32_t  value)

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

◆ ToString()

virtual String System::Details_Exception::ToString ( ) const
overridevirtual

Returns the string representation of the current object.

Reimplemented from System::Object.

Reimplemented in System::Details_ExceptionWithFilename< Details_SystemException >.

◆ what()

virtual const char* System::Details_Exception::what ( ) const
virtualnoexcept

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.

Returns
The description of the exception.

Member Data Documentation

◆ m_HResult

int32_t System::Details_Exception::m_HResult
mutableprotected

HRESULT code associated with the exception represented by the current object.

◆ m_innerexception

System::ExceptionWrapper<Details_Exception> System::Details_Exception::m_innerexception
protected

The Exception object representing the inner exception.

◆ m_message

String System::Details_Exception::m_message
protected

The error description.

◆ m_std_message

std::string System::Details_Exception::m_std_message
mutableprotected

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