This browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Download Microsoft Edge
More info about Internet Explorer and Microsoft Edge
public ref class FaultException : System::ServiceModel::CommunicationException
public class FaultException : System.ServiceModel.CommunicationException
[System.Serializable]
public class FaultException : System.ServiceModel.CommunicationException
[System.Serializable]
[System.Runtime.Serialization.KnownType(typeof(System.ServiceModel.FaultException+FaultCodeData[]))]
[System.Runtime.Serialization.KnownType(typeof(System.ServiceModel.FaultException+FaultReasonData[]))]
[System.Runtime.Serialization.KnownType(typeof(System.ServiceModel.FaultException+FaultCodeData))]
[System.Runtime.Serialization.KnownType(typeof(System.ServiceModel.FaultException+FaultReasonData))]
public class FaultException : System.ServiceModel.CommunicationException
type FaultException = class
inherit CommunicationException
[<System.Serializable>]
type FaultException = class
inherit CommunicationException
[<System.Serializable>]
[<System.Runtime.Serialization.KnownType(typeof(System.ServiceModel.FaultException+FaultCodeData[]))>]
[<System.Runtime.Serialization.KnownType(typeof(System.ServiceModel.FaultException+FaultReasonData[]))>]
[<System.Runtime.Serialization.KnownType(typeof(System.ServiceModel.FaultException+FaultCodeData))>]
[<System.Runtime.Serialization.KnownType(typeof(System.ServiceModel.FaultException+FaultReasonData))>]
type FaultException = class
inherit CommunicationException
Public Class FaultException
Inherits CommunicationException
Inheritance
FaultException
Examples
The following code example shows the use of a try/catch block to catch and handle
FaultException
objects thrown from a service. This often occurs when debugging is turned on in the service application.
using System;
using System.ServiceModel;
using System.ServiceModel.Channels;
using Microsoft.WCF.Documentation;
public class Client
public static void Main()
// Picks up configuration from the configuration file.
SampleServiceClient wcfClient = new SampleServiceClient();
// Making calls.
Console.WriteLine("Enter the greeting to send: ");
string greeting = Console.ReadLine();
Console.WriteLine("The service responded: " + wcfClient.SampleMethod(greeting));
Console.WriteLine("Press ENTER to exit:");
Console.ReadLine();
catch (TimeoutException timeProblem)
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 (FaultException<GreetingFault> 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 (FaultException faultEx)
Console.WriteLine("An unknown exception was received. "
+ faultEx.Message
+ faultEx.StackTrace
Console.Read();
wcfClient.Abort();
// Standard communication fault handler.
catch (CommunicationException commProblem)
Console.WriteLine("There was a communication problem. " + commProblem.Message + commProblem.StackTrace);
Console.Read();
wcfClient.Abort();
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()
' 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
In a service, use the
FaultException
class to create an untyped fault to return to the client for debugging purposes.
In a client, catch
FaultException
objects to handle unknown or generic faults, such as those returned by a service with the
IncludeExceptionDetailInFaults
property set to
true
. Because
FaultException
extends
CommunicationException
, remember to catch any
FaultException
objects prior to catching
CommunicationException
objects if you want to catch them separately.
Duplex services can also catch
FaultException
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
FaultException
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
FaultException
objects when you want the string to be passed to the constructor and retrieved by the client by calling the
FaultException<TDetail>.ToString
method. If you specify a fault contract of type
System.ServiceModel.FaultException<TDetail>
where the type parameter is
System.String
, the string value is available as the
FaultException<TDetail>.Detail
property and not by calling
FaultException<TDetail>.ToString
.
For details, see
Specifying and Handling Faults in Contracts and Services
.
Gets a collection of key/value pairs that provide additional user-defined information about the exception.
(Inherited from
Exception
)
When overridden in a derived class, returns the
Exception
that is the root cause of one or more subsequent exceptions.
(Inherited from
Exception
)
Obsolete.
When overridden in a derived class, sets the
SerializationInfo
with information about the exception.
(Inherited from
Exception
)
Obsolete.
Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.
(Inherited from
Exception
)
