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 LibraryFaultException()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 LibraryFaultException(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 LibraryFaultException(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 LibraryActionGets the value of the SOAP action for the fault message.
Public propertySupported by Portable Class LibraryCodeGets the fault code for the SOAP fault.
Public propertyDataGets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public propertyHelpLinkGets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Protected propertySupported by Portable Class LibraryHResultGets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public propertySupported by Portable Class LibraryInnerExceptionGets the Exception instance that caused the current exception. (Inherited from Exception.)
Public propertySupported by Portable Class LibraryMessageGets the message for the exception. (Overrides Exception.Message.)
Public propertySupported by Portable Class LibraryReasonGets the FaultReason for the SOAP fault.
Public propertySourceGets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public propertySupported by Portable Class LibraryStackTraceGets 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 LibraryCreateFault(MessageFault, Type[])Returns a FaultException object from the specified message fault and an array of detail types.
Public methodStatic memberSupported by Portable Class LibraryCreateFault(MessageFault, String, Type[])Returns a FaultException object from the specified message fault, action and an array of detail types.
Public methodSupported by Portable Class LibraryCreateMessageFaultReturns a MessageFault object.
Public methodSupported by Portable Class LibraryEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryFinalizeAllows 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 LibraryGetBaseExceptionWhen 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 LibraryGetHashCodeServes as a hash function for a particular type. (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 LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Portable Class LibraryToStringCreates 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 Handling Faults in Windows Communication Foundation Contracts.

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.


<system.serviceModel>
  <behaviors>
    <serviceBehaviors>
      <behavior>
        <serviceMetadata httpGetEnabled="true"/>
        <serviceDebug includeExceptionDetailInFaults="false"/>
        <!-- Add the greetingFaultBehavior -->
        <greetingFaultBehavior />
      </behavior>
    </serviceBehaviors>
  </behaviors>
  <serviceHostingEnvironment multipleSiteBindingsEnabled="true" />
  <!-- Register the class that implements the configuration element -->
  <extensions>
    <behaviorExtensions>
      <add
        name="greetingFaultBehavior"
        type="GreetingService.GreetingFaultBehaviorExtensionElement, GreetingService, Version=1.0.0.0, Culture=neutral"
      />
    </behaviorExtensions>
  </extensions>
</system.serviceModel>


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

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.

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

Community Additions

ADD
Show:
© 2014 Microsoft