ServiceDebugBehavior.HttpHelpPageEnabled Proprietà

Definizione

Spazio dei nomi:

System.ServiceModel.Description

Assembly:

System.ServiceModel.dll

Ottiene o imposta un valore che controlla se Windows Communication Foundation (WCF) pubblica una pagina della Guida HTML all'indirizzo controllato dalla proprietà 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

Valore della proprietà

Boolean

true se WCF pubblica una pagina della Guida HTML. In caso contrario, false. Il valore predefinito è true.

Esempio

Nell'esempio di codice seguente viene illustrato come utilizzare un file di configurazione per l'abilitazione della funzionalità delle pagine della Guida HTML e la restituzione al client di informazioni sulle eccezioni contenute in un errore SOAP a fini di debug. In questo file di configurazione vengono illustrati i seguenti passaggi di base che consentono l'aggiunta del supporto per le funzionalità di ServiceDebugBehavior:

• Poiché il ServiceDebugBehavior tipo è un'implementazione System.ServiceModel.Description.IServiceBehavior , l'elemento <del servizio> che rappresenta il tipo di servizio ha un identificatore di configurazione del comportamento di behaviorConfiguration="metadataAndDebug".

• Anche in questo caso, poiché il ServiceDebugBehavior tipo è un System.ServiceModel.Description.IServiceBehavior elemento di comportamento<> viene aggiunto a una <sezione serviceBehaviors>. Attributo name dell'elemento <di comportamento> il cui valore è l'identificatore dell'attributo dell'elemento behaviorConfiguration <del servizio> . In questo caso il valore è metadataAndDebug.

• Aggiungere un <elemento serviceDebug> con i vari attributi impostati sulla configurazione desiderata. In questo caso i valori httpHelpPageEnabled e includeExceptionDetailInFaults degli attributi sono impostati su 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>

Commenti

Impostare la proprietà HttpHelpPageEnabled su false per disabilitare la pubblicazione di una pagina della Guida HTML visibile ai browser HTML.

Per assicurarsi che la pagina della Guida HTML sia pubblicata nel percorso controllato dalla proprietà HttpsHelpPageUrl, è necessario impostare questa proprietà su true e deve venire soddisfatta anche una delle condizioni seguenti:

• La proprietà HttpsHelpPageUrl è un indirizzo assoluto che supporta lo schema del protocollo HTTP.

• È presente un indirizzo di base per il servizio che supporta lo schema del protocollo HTTP.

Sebbene venga generata un'eccezione se alla proprietà HttpsHelpPageUrl viene assegnato un indirizzo assoluto che non supporta lo schema del protocollo HTTP, qualsiasi altro scenario nel quale non viene soddisfatto nessuno dei criteri precedenti fa sì che non venga generata nessuna eccezione e non vi sia nessuna pagina della Guida HTML.