This documentation is archived and is not being maintained.

WebFaultException Class

Represents a fault that can have an associated HTTP status code.


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

public class WebFaultException : FaultException

The WebFaultException type exposes the following members.

Public methodWebFaultException(HttpStatusCode)Initializes a new instance of the WebFaultException class with the specified HttpStatusCode.
Protected methodWebFaultException(SerializationInfo, StreamingContext)Initializes a new instance of the WebFaultException() class with the specified SerializationInfo and StreamingContext.

Public propertyActionGets the value of the SOAP action for the fault message. (Inherited from FaultException.)
Public propertyCodeGets the fault code for the SOAP fault. (Inherited from FaultException.)
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 propertyHResultGets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public propertyInnerExceptionGets the Exception instance that caused the current exception. (Inherited from Exception.)
Public propertyMessageGets the message for the exception. (Inherited from FaultException.)
Public propertyReasonGets the FaultReason for the SOAP fault. (Inherited from FaultException.)
Public propertySourceGets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public propertyStackTraceGets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public propertyStatusCodeGets the HttpStatusCode associated with the fault.
Public propertyTargetSiteGets the method that throws the current exception. (Inherited from Exception.)

Public methodCreateMessageFaultReturns a MessageFault object. (Inherited from FaultException.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetBaseExceptionWhen overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetObjectDataAn implementation of the GetObjectData(SerializationInfo, StreamingContext) method that is called when an object is serialized to a stream. (Overrides FaultException.GetObjectData(SerializationInfo, StreamingContext).)
Public methodGetTypeGets the runtime type of the current instance. (Inherited from Exception.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringCreates and returns a string representation of the current exception. (Inherited from Exception.)

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

When using a WCF REST endpoint (WebHttpBinding and WebHttpBehavior or WebScriptEnablingBehavior) the HTTP status code on the response is set accordingly. However, WebFaultException can be used with non-REST endpoints and behaves like a regular FaultException.

When using a WCF REST endpoint, the response format of the serialized fault is determined in the same way as a non-fault response. For more information about WCF REST formatting, see WCF REST Formatting.

.NET Framework

Supported in: 4

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.