ServiceDebugBehavior.HttpHelpPageEnabled Właściwość

Definicja

Przestrzeń nazw:

System.ServiceModel.Description

Zestaw:

System.ServiceModel.dll

Pobiera lub ustawia wartość, która kontroluje, czy Windows Communication Foundation (WCF) publikuje stronę pomocy HTML pod adresem kontrolowanym HttpHelpPageUrl przez właściwość.

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

Wartość właściwości

Boolean

true jeśli program WCF publikuje stronę pomocy HTML; w przeciwnym razie , false. Wartość domyślna to true.

Przykłady

Poniższy przykład kodu pokazuje, jak użyć pliku konfiguracji, aby włączyć funkcję strony pomocy HTML i zwrócić informacje o wyjątku wewnątrz błędu protokołu SOAP z powrotem do klienta na potrzeby debugowania. Ten plik konfiguracji przedstawia następujące podstawowe kroki dodawania ServiceDebugBehavior obsługi funkcji:

• ServiceDebugBehavior Ponieważ typ jest implementacjąSystem.ServiceModel.Description.IServiceBehavior, <element usługi> reprezentujący typ usługi ma identyfikator behaviorConfiguration="metadataAndDebug"konfiguracji zachowania .

• Ponownie, ponieważ ServiceDebugBehavior typ jest implementacją System.ServiceModel.Description.IServiceBehavior , <element zachowania> jest dodawany do <sekcji serviceBehaviors> . Atrybut name <elementu behavior> , którego wartość jest identyfikatorem behaviorConfiguration atrybutu <elementu usługi> . W tym przypadku wartość to metadataAndDebug.

• <Dodaj element serviceDebug> z różnymi atrybutami ustawionymi na żądaną konfigurację. W tym przypadku wartości atrybutów httpHelpPageEnabled i includeExceptionDetailInFaults są ustawione na truewartość .

<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>

Uwagi

HttpHelpPageEnabled Ustaw właściwość na wartość , false aby wyłączyć publikację strony pomocy HTML widocznej dla przeglądarek HTML.

Aby upewnić się, że strona pomocy HTML jest publikowana w lokalizacji kontrolowanej HttpsHelpPageUrl przez właściwość, należy ustawić tę właściwość na true , a następnie jeden z następujących warunków musi mieć również wartość true:

• Właściwość HttpsHelpPageUrl jest adresem bezwzględnym obsługującym schemat protokołu HTTP.

• Istnieje adres podstawowy dla usługi, która obsługuje schemat protokołu HTTP.

Chociaż wyjątek jest zgłaszany, jeśli adres bezwzględny, który nie obsługuje schematu protokołu HTTP jest przypisany do HttpsHelpPageUrl właściwości, każdy inny scenariusz, w którym żaden z powyższych kryteriów nie spełnia żadnych wyników nie powoduje wyjątku i żadnej strony pomocy HTML.