Export (0) Print
Expand All

WebFaultException<T> Class

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

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

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

[SerializableAttribute]
public class WebFaultException<T> : FaultException<T>

Type Parameters

T

The serializable error detail type.

The WebFaultException<T> type exposes the following members.

  NameDescription
Public methodWebFaultException<T>(T, HttpStatusCode)Initializes a new instance of the WebFaultException<T> class with the specified exception detail and the WebFaultException to return to the caller.
Protected methodWebFaultException<T>(SerializationInfo, StreamingContext)Initializes a new instance of the WebFaultException<T> class with the specified SerializationInfo and StreamingContext
Public methodWebFaultException<T>(T, HttpStatusCode, IEnumerable<Type>)Initializes a new instance of the WebFaultException<T> class with the specified exception detail and the StatusCode to return to the caller.
Top

  NameDescription
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 propertyDetailGets the object that contains the detail information of the fault condition. (Inherited from FaultException<TDetail>.)
Public propertyHelpLinkGets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Public 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.)
Top

  NameDescription
Public methodCreateMessageFaultCreates a MessageFault object that can be used to create a Message that represents the SOAP fault. (Inherited from FaultException<TDetail>.)
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 the default hash function. (Inherited from Object.)
Public methodGetObjectDataAn implementation of the GetObjectData method that is called when an object is serialized to a stream. (Overrides FaultException<TDetail>.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 methodToStringReturns a string for the FaultException<TDetail> object. (Inherited from FaultException<TDetail>.)
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

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.

Use this class to return error details using the same format as the operation.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4

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