ServiceDebugBehavior.HttpHelpPageEnabled Egenskap

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

Egenskapsvärde

trueom WCF publicerar en HTML-hjälpsida; annars . false Standardvärdet är true.

Exempel

I följande kodexempel visas hur du använder en konfigurationsfil för att aktivera html-hjälpsidans funktion och returnera undantagsinformation i ett SOAP-fel tillbaka till klienten i felsökningssyfte. Den här konfigurationsfilen visar följande grundläggande steg för att lägga till stöd för ServiceDebugBehavior funktionerna:

• Eftersom typen ServiceDebugBehavior är en System.ServiceModel.Description.IServiceBehavior implementering <har tjänstelementet> som representerar tjänsttypen en beteendekonfigurationsidentifierare för behaviorConfiguration="metadataAndDebug".

• Eftersom typen ServiceDebugBehavior är en System.ServiceModel.Description.IServiceBehavior implementering läggs ett <beteendeelement> till i ett <serviceBehaviors-avsnitt> . Attributet name för <beteendeelementet> vars värde är identifieraren för behaviorConfigurationattributet för< tjänstelementet>. I det här fallet är värdet metadataAndDebug.

• Lägg till ett <serviceDebug-element> med de olika attributen inställda på önskad konfiguration. I det här fallet anges attributvärdena httpHelpPageEnabled och includeExceptionDetailInFaults till 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>

Kommentarer

Ange egenskapen HttpHelpPageEnabled till false för att inaktivera publiceringen av en HTML-hjälpsida som är synlig för HTML-webbläsare.

För att se till att HTML-hjälpsidan publiceras på den plats som styrs av HttpsHelpPageUrl egenskapen måste du ange den här egenskapen till true och sedan måste något av följande villkor också vara sant:

• Egenskapen HttpsHelpPageUrl är en absolut adress som stöder HTTP-protokollschemat.

• Det finns en basadress för tjänsten som stöder HTTP-protokollschemat.

Även om ett undantag utlöses om en absolut adress som inte stöder HTTP-protokollschemat tilldelas egenskapen HttpsHelpPageUrl , resulterar alla andra scenarion där inget av ovanstående kriterier uppfylls i något undantag och ingen HTML-hjälpsida.