ServiceDebugBehavior.IncludeExceptionDetailInFaults Propriété

Définition

Obtient ou définit une valeur qui spécifie si les informations sur les exceptions managées doivent être incluses dans le détail des erreurs SOAP retournées au client à des fins de débogage.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.

public:
 property bool IncludeExceptionDetailInFaults { bool get(); void set(bool value); };
public bool IncludeExceptionDetailInFaults { get; set; }
member this.IncludeExceptionDetailInFaults : bool with get, set
Public Property IncludeExceptionDetailInFaults As Boolean

Valeur de propriété

trueSi Windows Communication Foundation (WCF) retourne des informations sur les exceptions managées dans les erreurs SOAP à des fins de débogage du client; Sinon, false.true if Windows Communication Foundation (WCF) returns managed exception information in the SOAP faults for client debugging purposes; otherwise, false. La valeur par défaut est false.The default is false.

Exemples

L’exemple de code suivant indique comment utiliser un fichier de configuration pour activer la fonctionnalité de page d’aide HTML et retourner au client des informations relatives aux exceptions dans une erreur SOAP à des fins de débogage.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. Ce fichier de configuration illustre les étapes de base suivantes permettant de prévoir la prise en charge des fonctionnalités ServiceDebugBehavior :This configuration file shows the following basic steps to adding support for the ServiceDebugBehavior features:

<configuration>
  <system.serviceModel>
    <services>
      <!-- 
        Step 1. Add a behaviorConfiguration attribute
        in the <service> element.
      -->
      <service 
        name="Microsoft.WCF.Documentation.SampleService"
        behaviorConfiguration="metadataAndDebug">
        <host>
          <baseAddresses>
            <add baseAddress="http://localhost:8080/SampleService" />
          </baseAddresses>
        </host>
        <endpoint
          address=""
          binding="wsHttpBinding"
          contract="Microsoft.WCF.Documentation.ISampleService"
        />
        <endpoint
           address="mex"
           binding="mexHttpBinding"
           contract="IMetadataExchange"
        />
      </service>
    </services>
    <behaviors>
      <serviceBehaviors>
        <!-- 
          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">
          <serviceMetadata 
            httpGetEnabled="true" 
            httpGetUrl=""
          />
          <!-- 
            Step 3. Add a <serviceDebug> element and 
            modify the various attributes that suit your 
            scenario.
          -->
          <serviceDebug 
            httpHelpPageEnabled="true" 
            includeExceptionDetailInFaults="true"
          />
        </behavior>
      </serviceBehaviors>
    </behaviors>
  </system.serviceModel>
</configuration>

Remarques

Affectez IncludeExceptionDetailInFaults à la true propriété la valeur pour indiquer à WCF de retourner au client des informations sur les exceptions managées dans les erreurs SOAP pour faciliter le débogage.Set the IncludeExceptionDetailInFaults property to true to instruct WCF to return managed exception information to the client in SOAP faults to ease debugging.

Attention

Le retour d'informations sur les exceptions managées aux clients peut constituer un problème de sécurité, car les détails d'exception exposent des informations relatives à l'implémentation de service interne que des clients non autorisés pourraient utiliser.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. De plus, bien que les propriétés ServiceDebugBehavior puissent également être définies par programme, il peut être facile d'oublier de désactiver IncludeExceptionDetailInFaults lors du déploiement.In addition, although the ServiceDebugBehavior properties can also be set programmatically, it can be easy to forget to disable IncludeExceptionDetailInFaults when deploying.

Étant donné les problèmes de sécurité impliqués, il est vivement recommandé :Because of the security issues involved, it is strongly recommended that:

  • d'utiliser un fichier de configuration d'application pour affecter à la propriété IncludeExceptionDetailInFaults la valeur true ;You use an application configuration file to set the value of the IncludeExceptionDetailInFaults property to true.

  • de ne procéder ainsi que dans des scénarios de débogage contrôlés.You only do so only in controlled debugging scenarios.

Pour plus d’informations, consultez spécification et gestion des erreurs dans les contrats et les services.For more information, see Specifying and Handling Faults in Contracts and Services.

S’applique à