Represents a SOAP fault.
Assembly: System.ServiceModel (in System.ServiceModel.dll)
Thetype exposes the following members.
|FaultException||Initializes a new instance of the class.|
|FaultException(FaultReason)||Initializes a new instance of the class using the specified reason.|
|FaultException(MessageFault)||Initializes a new instance of the class using the specified message fault values.|
|FaultException(String)||Initializes a new instance of the class with the specified fault reason.|
|FaultException(FaultReason, FaultCode)||Initializes a new instance of the class using the specified reason and fault code.|
|FaultException(MessageFault, String)||Initializes a new instance of the class using the specified message fault values and the provided action string.|
|FaultException(SerializationInfo, StreamingContext)||Initializes a new instance of the class using the specified serialization information and context when deserializing a stream into a object.|
|FaultException(String, FaultCode)||Initializes a new instance of the class using the specified reason and SOAP fault code.|
|FaultException(FaultReason, FaultCode, String)||Initializes a new instance of the class using the specified reason, fault code, and action value.|
|FaultException(String, FaultCode, String)||Initializes a new instance of the class using the specified reason, fault code, and action value.|
|Action||Gets the value of the SOAP action for the fault message.|
|Code||Gets the fault code for the SOAP fault.|
|Data||Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)|
|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. (Overrides Exception.Message.)|
|Reason||Gets the FaultReason for the SOAP fault.|
|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.)|
|CreateFault(MessageFault, Type())||Returns a object from the specified message fault and an array of detail types.|
|CreateFault(MessageFault, String, Type())||Returns a object from the specified message fault, action and an array of detail types.|
|CreateMessageFault||Returns a MessageFault object.|
|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 Exception.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||Creates and returns a string representation of the current exception. (Inherited from Exception.)|
In a service, use the class to create an untyped fault to return to the client for debugging purposes.
In a client, catch objects to handle unknown or generic faults, such as those returned by a service with the IncludeExceptionDetailInFaults property set to true. Because extends CommunicationException, remember to catch any objects prior to catching CommunicationException objects if you want to catch them separately.
Duplex services can also catch objects returned from their interaction with a duplex client.
In general, it is strongly recommended that you use the FaultContractAttribute to design your services to return strongly-typed SOAP faults (and not managed exception objects) for all fault cases in which you decide the client requires fault information. However, use the in the following situations:
To send SOAP faults from a service for debugging purposes.
To catch SOAP faults on a client when the faults are not part of the service contract.
Throw objects when you want the string to be passed to the constructor and retrieved by the client by calling the FaultException(Of TDetail).ToString method. If you specify a fault contract of type System.ServiceModel.FaultException(Of TDetail) where the type parameter is System.String, the string value is available as the FaultException(Of TDetail).Detail property and not by calling FaultException(Of TDetail).ToString.
For details, see Handling Faults in Windows Communication Foundation Contracts.
The following code example shows the use of a try/catch block to catch and handle objects thrown from a service. This often occurs when debugging is turned on in the service application.
Imports System Imports System.ServiceModel Imports System.ServiceModel.Channels Imports Microsoft.WCF.Documentation Public Class Client Public Shared Sub Main() ' Picks up configuration from the configuration file. Dim wcfClient As New SampleServiceClient() Try ' Making calls. Console.WriteLine("Enter the greeting to send: ") Dim greeting As String = Console.ReadLine() Console.WriteLine("The service responded: " & wcfClient.SampleMethod(greeting)) Console.WriteLine("Press ENTER to exit:") Console.ReadLine() Catch timeProblem As TimeoutException Console.WriteLine("The service operation timed out. " & timeProblem.Message) wcfClient.Abort() Console.ReadLine() ' Catch the contractually specified SOAP fault raised here as an exception. Catch greetingFault As FaultException(Of GreetingFault) Console.WriteLine(greetingFault.Detail.Message) Console.Read() wcfClient.Abort() ' Catch unrecognized faults. This handler receives exceptions thrown by WCF ' services when ServiceDebugBehavior.IncludeExceptionDetailInFaults ' is set to true. Catch faultEx As FaultException Console.WriteLine("An unknown exception was received. " & faultEx.Message + faultEx.StackTrace) Console.Read() wcfClient.Abort() ' Standard communication fault handler. Catch commProblem As CommunicationException Console.WriteLine("There was a communication problem. " & commProblem.Message + commProblem.StackTrace) Console.Read() wcfClient.Abort() End Try End Sub End Class
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.