ServiceDebugBehavior.HttpHelpPageEnabled Propriété

Définition

Espace de noms:

System.ServiceModel.Description

Assembly:

System.ServiceModel.dll

Obtient ou définit une valeur qui contrôle si Windows Communication Foundation (WCF) publie une page d’aide HTML à l’adresse contrôlée par la propriété HttpHelpPageUrl.

public:
 property bool HttpHelpPageEnabled { bool get(); void set(bool value); };

public bool HttpHelpPageEnabled { get; set; }

member this.HttpHelpPageEnabled : bool with get, set

Public Property HttpHelpPageEnabled As Boolean

Valeur de propriété

Boolean

true si WCF publie une page d'aide HTML ; sinon false. La valeur par défaut est true.

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. Ce fichier de configuration illustre les étapes de base suivantes permettant de prévoir la prise en charge des fonctionnalités ServiceDebugBehavior :

• Étant donné que le ServiceDebugBehavior type est une System.ServiceModel.Description.IServiceBehavior implémentation, l’élément de< service> qui représente le type de service a un identificateur de configuration de comportement de behaviorConfiguration="metadataAndDebug".

• Là encore, comme le ServiceDebugBehavior type est une System.ServiceModel.Description.IServiceBehavior implémentation, un <élément de comportement> est ajouté à une <section serviceBehaviors> . Attribut name de l’élément <de comportement> dont la valeur est l’identificateur de l’attribut de l’élément behaviorConfiguration<de service> . Dans ce cas, la valeur est metadataAndDebug.

• Ajoutez un <élément serviceDebug> avec les différents attributs définis sur la configuration souhaitée. Dans ce cas, les valeurs d'attribut httpHelpPageEnabled et includeExceptionDetailInFaults sont true.

<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 la valeur HttpHelpPageEnabled à la propriété false pour désactiver la publication d'une page d'aide HTML visible par les navigateurs HTML.

Pour vous assurer que la page d'aide HTML est publiée à l'emplacement spécifié par la propriété HttpsHelpPageUrl, vous devez affecter à cette propriété la valeur true ; l'une des conditions suivantes doit également être respectée :

• La propriété HttpsHelpPageUrl est une adresse absolue qui prend en charge le schéma de protocole HTTP.

• Il existe une adresse de base pour le service qui prend en charge le schéma de protocole HTTP.

Bien qu'une exception soit levée si une adresse absolue qui ne prend pas en charge le schéma de protocole HTTP est assignée à la propriété HttpsHelpPageUrl, tout autre scénario dans lequel aucun des critères précédents n'est rempli ne lève pas d'exception et ne génère aucune page d'aide HTML.