FaultException Class
TOC
Collapse the table of content
Expand the table of content

FaultException Class

 

Represents a SOAP fault.

Namespace:   System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

System.Object
  System.Exception
    System.SystemException
      System.ServiceModel.CommunicationException
        System.ServiceModel.FaultException
          System.ServiceModel.FaultException<TDetail>
          System.ServiceModel.Web.WebFaultException

[SerializableAttribute]
public class FaultException : CommunicationException

NameDescription
System_CAPS_pubmethodFaultException()

Initializes a new instance of the FaultException class.

System_CAPS_pubmethodFaultException(FaultReason)

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

System_CAPS_pubmethodFaultException(FaultReason, FaultCode)

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

System_CAPS_pubmethodFaultException(FaultReason, FaultCode, String)

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

System_CAPS_pubmethodFaultException(MessageFault)

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

System_CAPS_pubmethodFaultException(MessageFault, String)

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

System_CAPS_protmethodFaultException(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.

System_CAPS_pubmethodFaultException(String)

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

System_CAPS_pubmethodFaultException(String, FaultCode)

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

System_CAPS_pubmethodFaultException(String, FaultCode, String)

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

NameDescription
System_CAPS_pubpropertyAction

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

System_CAPS_pubpropertyCode

Gets the fault code for the SOAP fault.

System_CAPS_pubpropertyData

Gets a collection of key/value pairs that provide additional user-defined information about the exception.(Inherited from Exception.)

System_CAPS_pubpropertyHelpLink

Gets or sets a link to the help file associated with this exception.(Inherited from Exception.)

System_CAPS_pubpropertyHResult

Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.(Inherited from Exception.)

System_CAPS_pubpropertyInnerException

Gets the Exception instance that caused the current exception.(Inherited from Exception.)

System_CAPS_pubpropertyMessage

Gets the message for the exception.(Overrides Exception.Message.)

System_CAPS_pubpropertyReason

Gets the FaultReason for the SOAP fault.

System_CAPS_pubpropertySource

Gets or sets the name of the application or the object that causes the error.(Inherited from Exception.)

System_CAPS_pubpropertyStackTrace

Gets a string representation of the immediate frames on the call stack.(Inherited from Exception.)

System_CAPS_pubpropertyTargetSite

Gets the method that throws the current exception.(Inherited from Exception.)

NameDescription
System_CAPS_pubmethodSystem_CAPS_staticCreateFault(MessageFault, String, Type[])

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

System_CAPS_pubmethodSystem_CAPS_staticCreateFault(MessageFault, Type[])

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

System_CAPS_pubmethodCreateMessageFault()

Returns a MessageFault object.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetBaseException()

When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.(Inherited from Exception.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetObjectData(SerializationInfo, StreamingContext)

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

System_CAPS_pubmethodGetType()

Gets the runtime type of the current instance.(Inherited from Exception.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Creates and returns a string representation of the current exception.(Inherited from Exception.)

NameDescription
System_CAPS_proteventSerializeObjectState

Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.(Inherited from Exception.)

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.

System_CAPS_noteNote

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.

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();
    }
  }
}

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 3.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft