ServiceDebugBehavior.HttpHelpPageEnabled Propriedade

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

Valor de Propriedade

true se a WCF publicar uma página de ajuda em HTML; caso contrário, false. A predefinição é true.

Exemplos

O seguinte exemplo de código mostra como usar um ficheiro de configuração para ativar a funcionalidade da página de ajuda HTML e devolver informação de exceção dentro de uma falha SOAP ao cliente para efeitos de depuração. Este ficheiro de configuração mostra os seguintes passos básicos para adicionar suporte às ServiceDebugBehavior funcionalidades:

• Como o ServiceDebugBehavior tipo é uma System.ServiceModel.Description.IServiceBehavior implementação, o <elemento de serviço> que representa o tipo de serviço tem um identificador de configuração de comportamento de behaviorConfiguration="metadataAndDebug".

• Mais uma vez, porque o ServiceDebugBehavior tipo é uma System.ServiceModel.Description.IServiceBehavior implementação, um <elemento de comportamento> é adicionado a uma <secção ServiceBehaviors> . O name atributo do <elemento de comportamento> cujo valor é o identificador do behaviorConfiguration atributo do <elemento de serviço> . Neste caso, o valor é metadataAndDebug.

• Adicione um <elemento serviceDebug> com os vários atributos definidos para a configuração desejada. Neste caso, os httpHelpPageEnabled valores do atributo e includeExceptionDetailInFaults são definidos como 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>

Observações

Defina a HttpHelpPageEnabled propriedade para false desativar a publicação de uma página de ajuda HTML visível para navegadores HTML.

Para garantir que a página de ajuda HTML é publicada na localização controlada pela HttpsHelpPageUrl propriedade, deve definir esta propriedade para true e, em seguida, uma das seguintes condições também deve ser verdadeira:

• A HttpsHelpPageUrl propriedade é um endereço absoluto que suporta o esquema do protocolo HTTP.

• Existe um endereço base para o serviço que suporta o esquema do protocolo HTTP.

Embora uma exceção seja lançada se um endereço absoluto que não suporta o esquema do protocolo HTTP for atribuído à HttpsHelpPageUrl propriedade, qualquer outro cenário em que nenhum dos critérios anteriores seja cumprido resulta em nenhuma exceção nem numa página de ajuda HTML.