SoapException Class
Represents the exception that is thrown when an XML Web service method is called over SOAP and an exception occurs.
Assembly: System.Web.Services (in System.Web.Services.dll)
System.Exception
System.SystemException
System.Web.Services.Protocols.SoapException
System.Web.Services.Protocols.SoapHeaderException
| Name | Description | |
|---|---|---|
 | SoapException() | Initializes a new instance of the SoapException class. |
 | SoapException(SerializationInfo, StreamingContext) | Initializes a new instance of the SoapException class with serialized data. |
| SoapException(String, XmlQualifiedName) | Initializes a new instance of the SoapException class with the specified exception message and exception code. |
| SoapException(String, XmlQualifiedName, Exception) | Initializes a new instance of the SoapException class with the specified exception message, exception code, and reference to the root cause of the exception. |
| SoapException(String, XmlQualifiedName, SoapFaultSubCode) | Initializes a new instance of the SoapException class with the specified exception message, exception code, and subcode. |
| SoapException(String, XmlQualifiedName, String) | Initializes a new instance of the SoapException class with the specified exception message, exception code, and URI that identifies the piece of code that caused the exception. |
| SoapException(String, XmlQualifiedName, String, Exception) | Initializes a new instance of the SoapException class with the specified exception message, exception code, URI that identifies the code that caused the exception, and reference to the root cause of the exception. |
| SoapException(String, XmlQualifiedName, String, String, String, XmlNode, SoapFaultSubCode, Exception) | Initializes a new instance of the SoapException class with the specified exception message, exception code, URI that identifies the piece of code that caused the exception, URI that represents the XML Web service's function in processing the SOAP message, the human language associated with the exception, the application-specific exception information, the subcode for the SOAP fault and reference to the root cause of the exception. |
| SoapException(String, XmlQualifiedName, String, String, XmlNode, SoapFaultSubCode, Exception) | Initializes a new instance of the SoapException class with the specified exception message, exception code, URI that identifies the piece of code that caused the exception, application-specific exception information, and reference to the root cause of the exception. |
| SoapException(String, XmlQualifiedName, String, XmlNode) | Initializes a new instance of the SoapException class with the specified exception message, exception code, URI that identifies the piece of code that caused the exception, and application specific exception information. |
| SoapException(String, XmlQualifiedName, String, XmlNode, Exception) | Initializes a new instance of the SoapException class with the specified exception message, exception code, URI that identifies the piece of code that caused the exception, application-specific exception information, and reference to the root cause of the exception. |
| Name | Description | |
|---|---|---|
 | Actor | Gets the piece of code that caused the exception. |
| Code | Gets the type of SOAP fault code. |
| Data | Gets a collection of key/value pairs that provide additional user-defined information about the exception.(Inherited from Exception.) |
| Detail | Gets an XmlNode that represents the application-specific error information details. |
| HelpLink | Gets or sets a link to the help file associated with this exception.(Inherited from Exception.) |
| HResult | Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.(Inherited from Exception.) |
| InnerException | |
| Lang | Gets the human language associated with the exception. |
| Message | Gets a message that describes the current exception.(Inherited from Exception.) |
| Node | Gets a URI that represents the piece of code that caused the exception. |
| Role | Gets a URI that represents the XML Web service's function in processing the SOAP message. |
| Source | Gets or sets the name of the application or the object that causes the error.(Inherited from Exception.) |
| StackTrace | Gets a string representation of the immediate frames on the call stack.(Inherited from Exception.) |
| SubCode | Gets the optional error information contained in the subcode XML element of a SOAP fault. |
| TargetSite | Gets the method that throws the current exception.(Inherited from Exception.) |
| Name | Description | |
|---|---|---|
| Equals(Object) | Determines whether the specified object is equal to the current object.(Inherited from Object.) |
| Finalize() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.) |
| GetBaseException() | |
| GetHashCode() | Serves as the default hash function. (Inherited from Object.) |
| GetObjectData(SerializationInfo, StreamingContext) | Sets the T:System.Runtime.Serialization.SerializationInfo with information about the exception.(Overrides Exception.GetObjectData(SerializationInfo, StreamingContext).) |
| GetType() | Gets the runtime type of the current instance.(Inherited from Exception.) |
 | IsClientFaultCode(XmlQualifiedName) | Returns a value that indicates whether the SOAP fault code is equivalent to the Client SOAP fault code regardless of the version of the SOAP protocol used. |
| IsMustUnderstandFaultCode(XmlQualifiedName) | Returns a value that indicates whether the SOAP fault code is equivalent to MustUnderstand regardless of the version of the SOAP protocol used. |
| IsServerFaultCode(XmlQualifiedName) | Returns a value that indicates whether the SOAP fault code is equivalent to the Server SOAP fault code regardless of the version of the SOAP protocol used. |
| IsVersionMismatchFaultCode(XmlQualifiedName) | Returns a value that indicates whether the SOAP fault code is equivalent to the VersionMismatch SOAP fault code regardless of the version of the SOAP protocol used. |
| MemberwiseClone() | |
| ToString() | Creates and returns a string representation of the current exception.(Inherited from Exception.) |
| Name | Description | |
|---|---|---|
 | ClientFaultCode | Specifies a SOAP fault code that represents a client call that is not formatted correctly or does not contain the appropriate information. |
| DetailElementName | Gets an XmlQualifiedName that represents the Detail element of a SOAP Fault code. |
| MustUnderstandFaultCode | A SOAP Fault Code that represents a SOAP element marked with the MustUnderstand attribute was not processed. |
| ServerFaultCode | Specifies that a SOAP fault code that represents an error occurred during the processing of a client call on the server, where the problem is not due to the message contents. |
| VersionMismatchFaultCode | A SOAP fault code that represents an invalid namespace for a SOAP envelope was found during the processing of the SOAP message. |
| Name | Description | |
|---|---|---|
 | SerializeObjectState | Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.(Inherited from Exception.) |
The SoapException can either be thrown by the common language runtime or by an XML Web service method. The common language runtime can throw a SoapException if a response to a request is not formatted correctly. XML Web service methods can generate a SoapException by simply throwing an exception within the XML Web service method. If the client accessed the method over SOAP, the exception is caught on the server and wrapped inside a new SoapException. The SoapException thrown has the following property values:
Property | Value |
|---|---|
The Message property of the original exception. | |
The URL of the XML Web service method. | |
null, but an empty detail element is present in the fault element. |
An XML Web service method might throw a SoapException when clients call using SOAP. If an XML Web service throws the SoapException, other details can be added through the Actor, Code and Detail properties that cannot otherwise be set by an XML Web service method if another type of exception is thrown.
The following example throws a SoapException where the XML Web service method sets the Detail property.
Available since 1.1
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.