ServiceDebugBehavior.HttpHelpPageEnabled Vlastnost

Definice

Obor názvů:

System.ServiceModel.Description

Sestavení:

System.ServiceModel.dll

Získá nebo nastaví hodnotu, která řídí, zda Windows Communication Foundation (WCF) publikuje stránku nápovědy HTML na adrese řízené HttpHelpPageUrl vlastností.

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

Hodnota vlastnosti

Boolean

truepokud WCF publikuje stránku nápovědy HTML; v opačném případě . false Výchozí hodnota je true.

Příklady

Následující příklad kódu ukazuje, jak pomocí konfiguračního souboru povolit funkci stránky nápovědy HTML a vrátit informace o výjimce uvnitř chyby SOAP zpět klientovi pro účely ladění. Tento konfigurační soubor ukazuje následující základní kroky pro přidání podpory pro ServiceDebugBehavior tyto funkce:

• Vzhledem k tomu, že typ ServiceDebugBehavior je System.ServiceModel.Description.IServiceBehavior implementace, <element služby> , který představuje typ služby má identifikátor behaviorConfiguration="metadataAndDebug"konfigurace chování .

• Opět, protože typ ServiceDebugBehavior je System.ServiceModel.Description.IServiceBehavior implementace <element chování> je přidán do <serviceBehaviors> oddílu. Atribut name<prvku chování> , jehož hodnota je identifikátor behaviorConfiguration atributu <prvku služby> . V tomto případě je hodnota metadataAndDebug.

• <Přidejte element ServiceDebug> s různými atributy nastavenými na požadovanou konfiguraci. V tomto případě jsou hodnoty atributu httpHelpPageEnabledincludeExceptionDetailInFaults nastaveny na 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>

Poznámky

HttpHelpPageEnabled Nastavte vlastnost tak, aby false se zakázala publikování stránky nápovědy HTML viditelné pro prohlížeče HTML.

Chcete-li zajistit, aby byla stránka nápovědy HTML publikována v umístění řízeném HttpsHelpPageUrl vlastností, musíte tuto vlastnost nastavit na true a poté musí být splněna jedna z následujících podmínek:

• Vlastnost HttpsHelpPageUrl je absolutní adresa, která podporuje schéma protokolu HTTP.

• Pro službu, která podporuje schéma protokolu HTTP, existuje základní adresa.

I když je vyvolána výjimka, pokud je vlastnost přiřazena HttpsHelpPageUrl absolutní adresa, která nepodporuje schéma protokolu HTTP, žádný jiný scénář, ve kterém není splněna žádná z předchozích kritérií, není splněna žádná výjimka a žádná stránka nápovědy HTML.