FaultException FaultException FaultException FaultException Class

Definition

Represents a SOAP fault.

public ref class FaultException : System::ServiceModel::CommunicationException
[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))]
[Serializable]
public class FaultException : System.ServiceModel.CommunicationException
type FaultException = class
    inherit CommunicationException
Public Class FaultException
Inherits CommunicationException
Inheritance
Derived
Attributes

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();
    try
    {
      // 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
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

Remarks

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.

Note

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.

Constructors

FaultException() FaultException() FaultException() FaultException()

Initializes a new instance of the FaultException class.

FaultException(FaultReason) FaultException(FaultReason) FaultException(FaultReason) FaultException(FaultReason)

Initializes a new instance of the FaultException class using the specified reason.

FaultException(FaultReason, FaultCode) FaultException(FaultReason, FaultCode) FaultException(FaultReason, FaultCode) FaultException(FaultReason, FaultCode)

Initializes a new instance of the FaultException class using the specified reason and fault code.

FaultException(FaultReason, FaultCode, String) FaultException(FaultReason, FaultCode, String) FaultException(FaultReason, FaultCode, String) FaultException(FaultReason, FaultCode, String)

Initializes a new instance of the FaultException class using the specified reason, fault code, and action value.

FaultException(MessageFault) FaultException(MessageFault) FaultException(MessageFault) FaultException(MessageFault)

Initializes a new instance of the FaultException class using the specified message fault values.

FaultException(MessageFault, String) FaultException(MessageFault, String) FaultException(MessageFault, String) FaultException(MessageFault, String)

Initializes a new instance of the FaultException class using the specified message fault values and the provided action string.

FaultException(SerializationInfo, StreamingContext) FaultException(SerializationInfo, StreamingContext) FaultException(SerializationInfo, StreamingContext) FaultException(SerializationInfo, StreamingContext)

Initializes a new instance of the FaultException class using the specified serialization information and context when deserializing a stream into a FaultException object.

FaultException(String) FaultException(String) FaultException(String) FaultException(String)

Initializes a new instance of the FaultException class with the specified fault reason.

FaultException(String, FaultCode) FaultException(String, FaultCode) FaultException(String, FaultCode) FaultException(String, FaultCode)

Initializes a new instance of the FaultException class using the specified reason and SOAP fault code.

FaultException(String, FaultCode, String) FaultException(String, FaultCode, String) FaultException(String, FaultCode, String) FaultException(String, FaultCode, String)

Initializes a new instance of the FaultException class using the specified reason, fault code, and action value.

Properties

Action Action Action Action

Gets the value of the SOAP action for the fault message.

Code Code Code Code

Gets the fault code for the SOAP fault.

Data Data Data Data

Gets a collection of key/value pairs that provide additional user-defined information about the exception.

(Inherited from Exception)
HelpLink HelpLink HelpLink HelpLink

Gets or sets a link to the help file associated with this exception.

(Inherited from Exception)
HResult HResult HResult HResult

Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.

(Inherited from Exception)
InnerException InnerException InnerException InnerException

Gets the Exception instance that caused the current exception.

(Inherited from Exception)
Message Message Message Message

Gets the message for the exception.

Reason Reason Reason Reason

Gets the FaultReason for the SOAP fault.

Source Source Source Source

Gets or sets the name of the application or the object that causes the error.

(Inherited from Exception)
StackTrace StackTrace StackTrace StackTrace

Gets a string representation of the immediate frames on the call stack.

(Inherited from Exception)
TargetSite TargetSite TargetSite TargetSite

Gets the method that throws the current exception.

(Inherited from Exception)

Methods

CreateFault(MessageFault, String, Type[]) CreateFault(MessageFault, String, Type[]) CreateFault(MessageFault, String, Type[]) CreateFault(MessageFault, String, Type[])

Returns a FaultException object from the specified message fault, action and an array of detail types.

CreateFault(MessageFault, Type[]) CreateFault(MessageFault, Type[]) CreateFault(MessageFault, Type[]) CreateFault(MessageFault, Type[])

Returns a FaultException object from the specified message fault and an array of detail types.

CreateMessageFault() CreateMessageFault() CreateMessageFault() CreateMessageFault()

Returns a MessageFault object.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetBaseException() GetBaseException() GetBaseException() 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() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext)

Implementation of the GetObjectData(SerializationInfo, StreamingContext) method that is called when the object is serialized into a stream.

GetType() GetType() GetType() GetType()

Gets the runtime type of the current instance.

(Inherited from Exception)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Creates and returns a string representation of the current exception.

(Inherited from Exception)

Events

SerializeObjectState SerializeObjectState SerializeObjectState SerializeObjectState

Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.

(Inherited from Exception)

Applies to