This documentation is archived and is not being maintained.

ServiceDebugBehavior.IncludeExceptionDetailInFaults Property

Gets or sets a value that specifies whether to include managed exception information in the detail of SOAP faults returned to the client for debugging purposes.

Namespace: System.ServiceModel.Description
Assembly: System.ServiceModel (in system.servicemodel.dll)

public bool IncludeExceptionDetailInFaults { get; set; }
/** @property */
public boolean get_IncludeExceptionDetailInFaults ()

/** @property */
public void set_IncludeExceptionDetailInFaults (boolean value)

public function get IncludeExceptionDetailInFaults () : boolean

public function set IncludeExceptionDetailInFaults (value : boolean)

Not applicable.

Property Value

true if Windows Communication Foundation (WCF) returns managed exception information in the SOAP faults for client debugging purposes; otherwise, false. The default is false.

Set the IncludeExceptionDetailInFaults property to true to instruct WCF to return managed exception information to the client in SOAP faults to ease debugging.

Caution noteCaution:

Returning managed exception information to clients can be a security risk because exception details expose information about the internal service implementation that could be used by unauthorized clients. In addition, although the ServiceDebugBehavior properties can also be set programmatically, it can be easy to forget to disable IncludeExceptionDetailInFaults when deploying.

Because of the security issues involved, it is strongly recommended that:

  • You use an application configuration file to set the value of the IncludeExceptionDetailInFaults property to true.

  • You only do so only in controlled debugging scenarios.

For more information, see Specifying and Handling Faults in Contracts and Services.

The following code example shows how to use a configuration file to enable the HTML help page feature and return exception information inside a SOAP fault back to the client for debugging purposes. This configuration file illustrates the three basic steps to adding support for the ServiceDebugBehavior features.

  1. Because the ServiceDebugBehavior type is an System.ServiceModel.Description.IServiceBehavior implementation, the <service> element that represents the service type has a behavior configuration identifier of behaviorConfiguration="metadataAndDebug".

  2. Again, because the ServiceDebugBehavior type is an System.ServiceModel.Description.IServiceBehavior implementation a <behavior> element is added to a <serviceBehaviors> section. Set the name attribute of the <behavior> element the value of which is the identifier of the behaviorConfiguration attribute of the <service> element. In this case, the value is metadataAndDebug.

  3. Add a <serviceDebug> element with the various attributes set to the desired configuration. In this case, the httpHelpPageEnabled and includeExceptionDetailInFaults attribute values are set to true.

        Step 1. Add a behaviorConfiguration attribute
        in the <service> element.
            <add baseAddress="http://localhost:8080/SampleService" />
          Step 2. Inside a <serviceBehaviors> section, add 
          a name attribute in the <behaviors> element that 
          matches the behaviorConfiguration attribute in the
          <service> element above.
        <behavior name="metadataAndDebug">
            Step 3. Add a <serviceDebug> element and 
            modify the various attributes that suit your 

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0