ServiceDebugBehavior.HttpHelpPageEnabled Eigenschaft

Definition

Namespace:

System.ServiceModel.Description

Assembly:

System.ServiceModel.dll

Dient zum Abrufen oder Festlegen eines Werts, der steuert, ob Windows Communication Foundation (WCF) eine HTML-Hilfeseite an der adresse veröffentlicht, die von der HttpHelpPageUrl Eigenschaft gesteuert wird.

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

Eigenschaftswert

Boolean

truewenn WCF eine HTML-Hilfeseite veröffentlicht; andernfalls . false Der Standardwert lautet true.

Beispiele

Das folgende Codebeispiel zeigt, wie Sie eine Konfigurationsdatei verwenden, um das HTML-Hilfeseitenfeature zu aktivieren und Ausnahmeinformationen innerhalb eines SOAP-Fehlers für Debuggingzwecke an den Client zurückzugeben. Diese Konfigurationsdatei zeigt die folgenden grundlegenden Schritte zum Hinzufügen der Unterstützung für die ServiceDebugBehavior Features:

• Da der ServiceDebugBehavior Typ eine System.ServiceModel.Description.IServiceBehavior Implementierung ist, weist das <Dienstelement> , das den Diensttyp darstellt, einen Verhaltenskonfigurationsbezeichner von behaviorConfiguration="metadataAndDebug".

• Da es sich bei dem ServiceDebugBehavior Typ um eine Implementierung handeltSystem.ServiceModel.Description.IServiceBehavior, wird einem Abschnitt "serviceBehaviors>" ein<<Verhaltenselement> hinzugefügt. Das name Attribut des <Verhaltenselements> , dessen Wert der Bezeichner des behaviorConfiguration Attributs des <Dienstelements> ist. In diesem Fall ist der Wert metadataAndDebug.

• Fügen Sie ein serviceDebug-Element<> mit den verschiedenen Attributen hinzu, die auf die gewünschte Konfiguration festgelegt sind. In diesem Fall werden die httpHelpPageEnabled Werte und includeExceptionDetailInFaults Attributwerte auf 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>

Hinweise

Legen Sie die HttpHelpPageEnabled Eigenschaft fest, um die Veröffentlichung einer HTML-Hilfeseite zu false deaktivieren, die für HTML-Browser sichtbar ist.

Um sicherzustellen, dass die HTML-Hilfeseite an dem speicherort veröffentlicht wird, der von der HttpsHelpPageUrl Eigenschaft gesteuert wird, müssen Sie diese Eigenschaft festlegen und true dann eine der folgenden Bedingungen auch erfüllt sein:

• Die HttpsHelpPageUrl Eigenschaft ist eine absolute Adresse, die das HTTP-Protokollschema unterstützt.

• Es gibt eine Basisadresse für den Dienst, der das HTTP-Protokollschema unterstützt.

Obwohl eine Ausnahme ausgelöst wird, wenn eine absolute Adresse, die das HTTP-Protokollschema nicht unterstützt, der HttpsHelpPageUrl Eigenschaft zugewiesen wird, führt jedes andere Szenario, in dem keine der vorherigen Kriterien erfüllt ist, keine Ausnahme und keine HTML-Hilfeseite.