FaultException Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Represents a SOAP fault.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class FaultException _
    Inherits CommunicationException

public class FaultException : CommunicationException

The FaultException type exposes the following members.

Constructors

	Name	Description
	FaultException()	Initializes a new instance of the FaultException class.
	FaultException(MessageFault, String)	Initializes a new instance of the FaultException class using the specified message fault values and the provided action string.
	FaultException(FaultReason, FaultCode, String)	Initializes a new instance of the FaultException class using the specified reason, fault code, and action value.

Top

Properties

	Name	Description
	Action	Gets the value of the SOAP action for the fault message.
	Code	Gets the fault code for the SOAP fault.
	Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
	HResult	Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
	InnerException	Gets the Exception instance that caused the current exception. (Inherited from Exception.)
	Message	Gets the message for the exception. (Overrides Exception.Message.)
	Reason	Gets the FaultReason for the SOAP fault.
	StackTrace	Gets a string representation of the frames on the call stack at the time the current exception was thrown. (Inherited from Exception.)

Top

Methods

	Name	Description
	CreateFault(MessageFault, array<Type[])	Returns a FaultException object from the specified message fault and an array of detail types.
	CreateFault(MessageFault, String, array<Type[])	Returns a FaultException object from the specified message fault, action, and an array of detail types.
	CreateMessageFault	Returns an in-memory MessageFault object.
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	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	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the runtime type of the current instance. (Inherited from Exception.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Creates and returns a string representation of the current exception. (Inherited from Exception.)

Top

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. Because FaultException extends CommunicationException, remember to catch any FaultException objects prior to catching CommunicationException objects if you want to catch them separately.

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 one of the parameters is of type System.String, the value of the string is available as the FaultException<TDetail>.Detail property and the FaultException<TDetail>.ToString method need not be called to recover the reason descried in the value.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

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

See Also

Reference

System.ServiceModel Namespace