FaultException<TDetail> Class
Used in a client application to catch contractually-specified SOAP faults.
System::Exception
System::SystemException
System.ServiceModel::CommunicationException
System.ServiceModel::FaultException
System.ServiceModel::FaultException<TDetail>
System.ServiceModel.Web::WebFaultException<T>
Assembly: System.ServiceModel (in System.ServiceModel.dll)
The FaultException<TDetail> type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | FaultException<TDetail>(TDetail) | Initializes a new instance of the FaultException<TDetail> class that uses the specified detail object. |
![]() | FaultException<TDetail>(TDetail, FaultReason) | Initializes a new instance of the FaultException<TDetail> class that uses the specified detail object and fault reason. |
![]() | FaultException<TDetail>(TDetail, String) | Initializes a new instance of the FaultException<TDetail> class that uses the specified detail and fault reason. |
![]() | FaultException<TDetail>(SerializationInfo, StreamingContext) | Initializes a new instance of the FaultException<TDetail> class using the specified serialization information and context when deserializing a stream into a FaultException object. |
![]() | FaultException<TDetail>(TDetail, FaultReason, FaultCode) | Initializes a new instance of the FaultException<TDetail> class that uses the specified detail object, fault reason, and fault code. |
![]() | FaultException<TDetail>(TDetail, String, FaultCode) | Initializes a new instance of the FaultException<TDetail> class that uses the specified detail object, fault reason, and fault code. |
![]() ![]() | FaultException<TDetail>(TDetail, FaultReason, FaultCode, String) | Initializes a new instance of the FaultException<TDetail> class that uses the specified detail object, and SOAP fault reason, code and action values. |
![]() | FaultException<TDetail>(TDetail, String, FaultCode, String) | Initializes a new instance of the FaultException<TDetail> class that uses the specified detail object, and SOAP fault reason, code and action values. |
| Name | Description | |
|---|---|---|
![]() ![]() | Action | Gets the value of the SOAP action for the fault message. (Inherited from FaultException.) |
![]() ![]() | Code | Gets the fault code for the SOAP fault. (Inherited from FaultException.) |
![]() | Data | Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.) |
![]() ![]() | Detail | Gets the object that contains the detail information of the fault condition. |
![]() | 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 | Gets the Exception instance that caused the current exception. (Inherited from Exception.) |
![]() ![]() | Message | Gets the message for the exception. (Inherited from FaultException.) |
![]() ![]() | Reason | Gets the FaultReason for the SOAP fault. (Inherited from FaultException.) |
![]() | 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.) |
![]() | TargetSite | Gets the method that throws the current exception. (Inherited from Exception.) |
| Name | Description | |
|---|---|---|
![]() | CreateMessageFault | Creates a MessageFault object that can be used to create a Message that represents the SOAP fault. (Overrides FaultException::CreateMessageFault().) |
![]() ![]() | 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 | When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.) |
![]() ![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetObjectData | Implementation of the ISerializable::GetObjectData method that is called when the object is serialized into a stream. (Overrides FaultException::GetObjectData(SerializationInfo, StreamingContext).) |
![]() | GetType | Gets the runtime type of the current instance. (Inherited from Exception.) |
![]() ![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() ![]() | ToString | Returns a string for the FaultException<TDetail> object. (Overrides Exception::ToString().) |
| 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.) |
Catch the FaultException<TDetail> object in a client application to handle a SOAP fault that has been contractually specified in an operation contract.
Typical deployed services use the FaultContractAttribute to formally specify all SOAP faults that a client can expect to receive in the normal course of an operation. Error information in a FaultContractAttribute appears as a FaultException<TDetail> (where the typeparameter is the serializable error object specified in the operation's FaultContractAttribute) when it arrives at a client application. The FaultContractAttribute can be used to specify SOAP faults for both two-way service methods and for asynchronous method pairs.
Because FaultException<TDetail> is both a FaultException and therefore a CommunicationException, to catch specified SOAP faults make sure you catch the FaultException<TDetail> types prior to the FaultException and CommunicationException types or handle the specified exceptions in one of those exception handlers.
Note |
|---|
If you use System.ServiceModel::FaultContractAttribute to specify a FaultException<TDetail> where the type parameter is a System::String, the string value is assigned to the Detail property in the client application; clients cannot retrieve that string by calling the FaultException<TDetail>::ToString method. To have the string value returned when the client application calls Exception::ToString, throw a System.ServiceModel::FaultException exception inside the operation and pass the string to the constructor. In general, it is recommended that detail types be custom serializable types appropriate to the fault and not a System::String. |
The following code example shows how a service uses the FaultException<TDetail> type to throw a managed exception that gets converted into the SOAP fault specified by the FaultContractAttribute.
The following code example shows how the client code looks when imported by the client using the Service Model Metadata Utility Tool (Svcutil.exe).
The following code example shows how a client can catch the FaultException<TDetail> type that represents the custom SOAP fault specified in the operation contract.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.


