ServiceDebugBehavior.HttpHelpPageEnabled Eigenschaft

Referenz

Definition

Namespace:: System.ServiceModel.Description

Assembly:: System.ServiceModel.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Ruft einen Wert ab oder legt einen Wert fest, der steuert, ob Windows Communication Foundation (WCF) eine HTML-Seite an der Adresse veröffentlicht, die durch die 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

true, wenn WCF eine HTML-Hilfeseite veröffentlicht, andernfalls false. Der Standardwert ist true.

Beispiele

Das folgende Codebeispiel zeigt, wie eine Konfigurationsdatei verwendet wird, um die HTML-Hilfeseitenfunktion zu aktivieren und Ausnahmeinformationen innerhalb eines SOAP-Fehlers für Debugzwecke an den Client zurückzugeben. Diese Konfigurationsdatei veranschaulicht 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, den Bezeichner für die Verhaltenskonfiguration von aufbehaviorConfiguration="metadataAndDebug".
Da der ServiceDebugBehavior Typ eine System.ServiceModel.Description.IServiceBehavior Implementierung ist, wird einem abschnitt serviceBehaviors> ein<<behavior-Element> hinzugefügt. Das name Attribut des <behavior-Elements> , dessen Wert der Bezeichner des behaviorConfiguration Attributs des <Dienstelements> ist. In diesem Fall handelt es sich um den 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- und includeExceptionDetailInFaults-Attributwerte auf true festgelegt.

<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 auf false fest, um die Veröffentlichung einer in HTML-Browsern anzeigbaren HTML-Hilfeseite zu deaktivieren.

Um sicherzustellen, dass die HTML-Hilfeseite an dem Speicherort veröffentlicht wird, der von der HttpsHelpPageUrl-Eigenschaft gesteuert wird, müssen Sie diese Eigenschaft auf true festlegen. Zudem muss eine der folgenden Bedingungen zutreffen:

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 ausgegeben wird, wenn eine absolute Adresse, die das HTTP-Protokollschema nicht unterstützt, der HttpsHelpPageUrl-Eigenschaft zugewiesen wird, werden bei allen anderen Szenarien, die den vorstehenden Kriterien nicht entsprechen, keine Ausnahmen und HTML-Hilfeseiten ausgegeben.

Gilt für:

Freigeben über