Export (0) Print
Expand All

FaultException Class

Represents a SOAP fault.

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

[SerializableAttribute]
public class FaultException : CommunicationException

The FaultException type exposes the following members.

  NameDescription
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsFaultException()Initializes a new instance of the FaultException class.
Public methodFaultException(FaultReason)Initializes a new instance of the FaultException class using the specified reason.
Public methodFaultException(MessageFault)Initializes a new instance of the FaultException class using the specified message fault values.
Public methodFaultException(String)Initializes a new instance of the FaultException class with the specified fault reason.
Public methodFaultException(FaultReason, FaultCode)Initializes a new instance of the FaultException class using the specified reason and fault code.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsFaultException(MessageFault, String)Initializes a new instance of the FaultException class using the specified message fault values and the provided action string.
Protected methodFaultException(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.
Public methodFaultException(String, FaultCode)Initializes a new instance of the FaultException class using the specified reason and SOAP fault code.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsFaultException(FaultReason, FaultCode, String)Initializes a new instance of the FaultException class using the specified reason, fault code, and action value.
Public methodFaultException(String, FaultCode, String)Initializes a new instance of the FaultException class using the specified reason, fault code, and action value.
Top

  NameDescription
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsActionGets the value of the SOAP action for the fault message.
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsCodeGets the fault code for the SOAP fault.
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsDataGets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsHelpLinkGets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsHResultGets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsInnerExceptionGets the Exception instance that caused the current exception. (Inherited from Exception.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsMessageGets the message for the exception. (Overrides Exception.Message.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsReasonGets the FaultReason for the SOAP fault.
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsSourceGets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsStackTraceGets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public propertyTargetSiteGets the method that throws the current exception. (Inherited from Exception.)
Top

  NameDescription
Public methodStatic memberSupported by Portable Class LibrarySupported in .NET for Windows Store appsCreateFault(MessageFault, Type[])Returns a FaultException object from the specified message fault and an array of detail types.
Public methodStatic memberSupported by Portable Class LibrarySupported in .NET for Windows Store appsCreateFault(MessageFault, String, Type[])Returns a FaultException object from the specified message fault, action and an array of detail types.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsCreateMessageFaultReturns a MessageFault object.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetBaseExceptionWhen overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetObjectDataImplementation of the ISerializable.GetObjectData method that is called when the object is serialized into a stream. (Overrides Exception.GetObjectData(SerializationInfo, StreamingContext).)
Public methodGetTypeGets the runtime type of the current instance. (Inherited from Exception.)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsToStringCreates and returns a string representation of the current exception. (Inherited from Exception.)
Top

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

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.

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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