Asposecpplib
System::Web::Services::Protocols::Details_SoapException Class Reference

Represents the exception thrown when method is called over SOAP and an error occurs. Never create instances of this class manually. Use the SoapException class instead. Never wrap the SoapException class instances into System::SmartPtr. More...

Inherits System::Details_SystemException.

Public Member Functions

String get_Actor ()
 Returns the code piece where the exception is thrown when SOAP version 1.1 is used. More...
 
System::SharedPtr< Xml::XmlQualifiedNameget_Code ()
 Returns a namespace qualified local name in format 'namespace:localname' that specifies the SOAP fault code. More...
 
System::SharedPtr< Xml::XmlNodeget_Detail ()
 Returns details about the thrown exception. More...
 
String get_Lang ()
 Returns the language, which is used to localize exception properties. More...
 
String get_Role ()
 Returns the role of the XML web service that throws the exception. More...
 
System::SharedPtr< SoapFaultSubCode > get_SubCode ()
 Returns optional information from the 'subcode' XML element. More...
 
String get_Node ()
 Returns the code piece where the exception is thrown when SOAP version 1.2 is used. More...
 
 Details_SoapException ()
 Constructs a new instance. More...
 
 Details_SoapException (String message, System::SharedPtr< Xml::XmlQualifiedName > code)
 Constructs a new instance. More...
 
 Details_SoapException (String message, System::SharedPtr< Xml::XmlQualifiedName > code, Exception innerException)
 Constructs a new instance. More...
 
 Details_SoapException (String message, System::SharedPtr< Xml::XmlQualifiedName > code, String actor)
 Constructs a new instance. More...
 
 Details_SoapException (String message, System::SharedPtr< Xml::XmlQualifiedName > code, String actor, Exception innerException)
 Constructs a new instance. More...
 
 Details_SoapException (String message, System::SharedPtr< Xml::XmlQualifiedName > code, String actor, System::SharedPtr< Xml::XmlNode > detail)
 Constructs a new instance. More...
 
 Details_SoapException (String message, System::SharedPtr< Xml::XmlQualifiedName > code, String actor, System::SharedPtr< Xml::XmlNode > detail, Exception innerException)
 Constructs a new instance. More...
 
 Details_SoapException (String message, System::SharedPtr< Xml::XmlQualifiedName > code, System::SharedPtr< SoapFaultSubCode > subcode)
 Constructs a new instance. More...
 
 Details_SoapException (String message, System::SharedPtr< Xml::XmlQualifiedName > code, String actor, String role, System::SharedPtr< Xml::XmlNode > detail, System::SharedPtr< SoapFaultSubCode > subcode, Exception innerException)
 Constructs a new instance. More...
 
 Details_SoapException (String message, System::SharedPtr< Xml::XmlQualifiedName > code, String actor, String role, String lang, System::SharedPtr< Xml::XmlNode > detail, System::SharedPtr< SoapFaultSubCode > subcode, Exception innerException)
 Constructs a new instance. More...
 
- Public Member Functions inherited from System::Details_SystemException
const System::TypeInfoGetType () const override
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
bool Is (const System::TypeInfo &target) const override
 
- 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_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...
 
- 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 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...
 

Static Public Member Functions

static bool IsClientFaultCode (System::SharedPtr< Xml::XmlQualifiedName > code)
 Checks if the specified code is equal to the 'Client' SOAP fault code. More...
 
static bool IsMustUnderstandFaultCode (System::SharedPtr< Xml::XmlQualifiedName > code)
 Checks if the specified code is equal to the 'MustUnderstand' SOAP fault code. More...
 
static bool IsServerFaultCode (System::SharedPtr< Xml::XmlQualifiedName > code)
 Checks if the specified code is equal to the 'Server' SOAP fault code. More...
 
static bool IsVersionMismatchFaultCode (System::SharedPtr< Xml::XmlQualifiedName > code)
 Checks if the specified code is equal to the 'VersionMismatch' SOAP fault code. More...
 
- Static Public Member Functions inherited from System::Details_SystemException
static const System::TypeInfoType ()
 
- 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...
 

Static Public Attributes

static System::SharedPtr< Xml::XmlQualifiedNameClientFaultCode
 A SOAP fault code that represents a client call that is formatted incorrectly or doesn't contain required information. More...
 
static System::SharedPtr< Xml::XmlQualifiedNameDetailElementName
 A namespace qualified local name in format 'namespace:localname'. More...
 
static System::SharedPtr< Xml::XmlQualifiedNameMustUnderstandFaultCode
 A SOAP fault code that indicates if the SOAP element marked by the 'MustUnderstand' attribute is not processed. More...
 
static System::SharedPtr< Xml::XmlQualifiedNameServerFaultCode
 A SOAP fault code that represents an error occurred on the server. More...
 
static System::SharedPtr< Xml::XmlQualifiedNameVersionMismatchFaultCode
 A SOAP fault code that represents an invalid namespace. More...
 

Protected Member Functions

void DoThrow (const System::ExceptionPtr &self) const override
 Throws exception instance wrapped by exception wrapper. More...
 
- Protected Member Functions inherited from System::Details_SystemException
 Details_SystemException ()
 
 Details_SystemException (const System::String &message)
 
 Details_SystemException (const System::String &message, const System::ExceptionWrapper< System::Details_Exception > &innerException)
 
 Details_SystemException (const System::SharedPtr< System::Runtime::Serialization::SerializationInfo > &info, System::Runtime::Serialization::StreamingContext context)
 
void DoThrow (const System::ExceptionPtr &self) const override
 Throws exception instance wrapped by exception wrapper. 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< Objectptr
 Alias for smart pointer type. More...
 
- Protected Types inherited from System::Details_SystemException
using BaseType = System::Details_Exception
 
- Protected Attributes inherited from System::Details_Exception
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...
 

Detailed Description

Represents the exception thrown when method is called over SOAP and an error occurs. Never create instances of this class manually. Use the SoapException class instead. Never wrap the SoapException class instances into System::SmartPtr.

Constructor & Destructor Documentation

◆ Details_SoapException() [1/10]

System::Web::Services::Protocols::Details_SoapException::Details_SoapException ( )

Constructs a new instance.

◆ Details_SoapException() [2/10]

System::Web::Services::Protocols::Details_SoapException::Details_SoapException ( String  message,
System::SharedPtr< Xml::XmlQualifiedName code 
)

Constructs a new instance.

Parameters
messageThe exception message.
codeThe exception code.

◆ Details_SoapException() [3/10]

System::Web::Services::Protocols::Details_SoapException::Details_SoapException ( String  message,
System::SharedPtr< Xml::XmlQualifiedName code,
Exception  innerException 
)

Constructs a new instance.

Parameters
messageThe exception message.
codeThe exception code.
innerExceptionThe inner exception.

◆ Details_SoapException() [4/10]

System::Web::Services::Protocols::Details_SoapException::Details_SoapException ( String  message,
System::SharedPtr< Xml::XmlQualifiedName code,
String  actor 
)

Constructs a new instance.

Parameters
messageThe exception message.
codeThe exception code.
actorThe code piece where the exception is thrown.

◆ Details_SoapException() [5/10]

System::Web::Services::Protocols::Details_SoapException::Details_SoapException ( String  message,
System::SharedPtr< Xml::XmlQualifiedName code,
String  actor,
Exception  innerException 
)

Constructs a new instance.

Parameters
messageThe exception message.
codeThe exception code.
actorThe code piece where the exception is thrown.
innerExceptionThe inner exception.

◆ Details_SoapException() [6/10]

System::Web::Services::Protocols::Details_SoapException::Details_SoapException ( String  message,
System::SharedPtr< Xml::XmlQualifiedName code,
String  actor,
System::SharedPtr< Xml::XmlNode detail 
)

Constructs a new instance.

Parameters
messageThe exception message.
codeThe exception code.
actorThe code piece where the exception is thrown.
detailDetails about the thrown exception.

◆ Details_SoapException() [7/10]

System::Web::Services::Protocols::Details_SoapException::Details_SoapException ( String  message,
System::SharedPtr< Xml::XmlQualifiedName code,
String  actor,
System::SharedPtr< Xml::XmlNode detail,
Exception  innerException 
)

Constructs a new instance.

Parameters
messageThe exception message.
codeThe exception code.
actorThe code piece where the exception is thrown.
detailDetails about the thrown exception.
innerExceptionThe inner exception.

◆ Details_SoapException() [8/10]

System::Web::Services::Protocols::Details_SoapException::Details_SoapException ( String  message,
System::SharedPtr< Xml::XmlQualifiedName code,
System::SharedPtr< SoapFaultSubCode >  subcode 
)

Constructs a new instance.

Parameters
messageThe exception message.
codeThe exception code.
subcodeOptional information from the 'subcode' XML element.

◆ Details_SoapException() [9/10]

System::Web::Services::Protocols::Details_SoapException::Details_SoapException ( String  message,
System::SharedPtr< Xml::XmlQualifiedName code,
String  actor,
String  role,
System::SharedPtr< Xml::XmlNode detail,
System::SharedPtr< SoapFaultSubCode >  subcode,
Exception  innerException 
)

Constructs a new instance.

Parameters
messageThe exception message.
codeThe exception code.
actorThe code piece where the exception is thrown.
roleThe role of the XML web service that throws the exception.
detailDetails about the thrown exception.
subcodeOptional information from the 'subcode' XML element.
innerExceptionThe inner exception.

◆ Details_SoapException() [10/10]

System::Web::Services::Protocols::Details_SoapException::Details_SoapException ( String  message,
System::SharedPtr< Xml::XmlQualifiedName code,
String  actor,
String  role,
String  lang,
System::SharedPtr< Xml::XmlNode detail,
System::SharedPtr< SoapFaultSubCode >  subcode,
Exception  innerException 
)

Constructs a new instance.

Parameters
messageThe exception message.
codeThe exception code.
actorThe code piece where the exception is thrown.
roleThe role of the XML web service that throws the exception.
langThe language, which is used to localize exception properties.
detailDetails about the thrown exception.
subcodeOptional information from the 'subcode' XML element.
innerExceptionThe inner exception.

Member Function Documentation

◆ DoThrow()

void System::Web::Services::Protocols::Details_SoapException::DoThrow ( const System::ExceptionPtr self) const
inlineoverrideprotectedvirtual

Throws exception instance wrapped by exception wrapper.

Parameters
selfException instance to be thrown.

Reimplemented from System::Details_Exception.

◆ get_Actor()

String System::Web::Services::Protocols::Details_SoapException::get_Actor ( )

Returns the code piece where the exception is thrown when SOAP version 1.1 is used.

Returns
The code piece where the exception is thrown.

◆ get_Code()

System::SharedPtr<Xml::XmlQualifiedName> System::Web::Services::Protocols::Details_SoapException::get_Code ( )

Returns a namespace qualified local name in format 'namespace:localname' that specifies the SOAP fault code.

Returns
A namespace qualified local name in format 'namespace:localname' that specifies the SOAP fault code.

◆ get_Detail()

System::SharedPtr<Xml::XmlNode> System::Web::Services::Protocols::Details_SoapException::get_Detail ( )

Returns details about the thrown exception.

Returns
Details about the thrown exception.

◆ get_Lang()

String System::Web::Services::Protocols::Details_SoapException::get_Lang ( )

Returns the language, which is used to localize exception properties.

Returns
The language, which is used to localize exception properties.

◆ get_Node()

String System::Web::Services::Protocols::Details_SoapException::get_Node ( )

Returns the code piece where the exception is thrown when SOAP version 1.2 is used.

Returns
The code piece where the exception is thrown.

◆ get_Role()

String System::Web::Services::Protocols::Details_SoapException::get_Role ( )

Returns the role of the XML web service that throws the exception.

Returns
The role of the XML web service that throws the exception.

◆ get_SubCode()

System::SharedPtr<SoapFaultSubCode> System::Web::Services::Protocols::Details_SoapException::get_SubCode ( )

Returns optional information from the 'subcode' XML element.

Returns
Optional information from the 'subcode' XML element.

◆ IsClientFaultCode()

static bool System::Web::Services::Protocols::Details_SoapException::IsClientFaultCode ( System::SharedPtr< Xml::XmlQualifiedName code)
static

Checks if the specified code is equal to the 'Client' SOAP fault code.

Parameters
codeThe SOAP fault code to check.
Returns
True when the specified code is equal to the 'Client' SOAP fault code, otherwise false.

◆ IsMustUnderstandFaultCode()

static bool System::Web::Services::Protocols::Details_SoapException::IsMustUnderstandFaultCode ( System::SharedPtr< Xml::XmlQualifiedName code)
static

Checks if the specified code is equal to the 'MustUnderstand' SOAP fault code.

Parameters
codeThe SOAP fault code to check.
Returns
True when the specified code is equal to the 'MustUnderstand' SOAP fault code, otherwise false.

◆ IsServerFaultCode()

static bool System::Web::Services::Protocols::Details_SoapException::IsServerFaultCode ( System::SharedPtr< Xml::XmlQualifiedName code)
static

Checks if the specified code is equal to the 'Server' SOAP fault code.

Parameters
codeThe SOAP fault code to check.
Returns
True when the specified code is equal to the 'Server' SOAP fault code, otherwise false.

◆ IsVersionMismatchFaultCode()

static bool System::Web::Services::Protocols::Details_SoapException::IsVersionMismatchFaultCode ( System::SharedPtr< Xml::XmlQualifiedName code)
static

Checks if the specified code is equal to the 'VersionMismatch' SOAP fault code.

Parameters
codeThe SOAP fault code to check.
Returns
True when the specified code is equal to the 'VersionMismatch' SOAP fault code, otherwise false.

Member Data Documentation

◆ ClientFaultCode

System::SharedPtr<Xml::XmlQualifiedName> System::Web::Services::Protocols::Details_SoapException::ClientFaultCode
static

A SOAP fault code that represents a client call that is formatted incorrectly or doesn't contain required information.

◆ DetailElementName

System::SharedPtr<Xml::XmlQualifiedName> System::Web::Services::Protocols::Details_SoapException::DetailElementName
static

A namespace qualified local name in format 'namespace:localname'.

◆ MustUnderstandFaultCode

System::SharedPtr<Xml::XmlQualifiedName> System::Web::Services::Protocols::Details_SoapException::MustUnderstandFaultCode
static

A SOAP fault code that indicates if the SOAP element marked by the 'MustUnderstand' attribute is not processed.

◆ ServerFaultCode

System::SharedPtr<Xml::XmlQualifiedName> System::Web::Services::Protocols::Details_SoapException::ServerFaultCode
static

A SOAP fault code that represents an error occurred on the server.

◆ VersionMismatchFaultCode

System::SharedPtr<Xml::XmlQualifiedName> System::Web::Services::Protocols::Details_SoapException::VersionMismatchFaultCode
static

A SOAP fault code that represents an invalid namespace.