ServiceDebugBehavior.HttpHelpPageEnabled Свойство

Определение

Пространство имен:

System.ServiceModel.Description

Сборка:

System.ServiceModel.dll

Возвращает или задает значение, определяющее, публикует ли служба Windows Communication Foundation (WCF) справочную HTML-страницу по адресу, управляемому свойством 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

Значение свойства

Boolean

Значение true если служба WCF публикует справочную HTML-страницу; в противном случае — значение false. Значение по умолчанию — true.

Примеры

В следующем примере кода показано использование файла конфигурации для включения возможностей страницы справки HTML и возврата информации об исключении в ошибке SOAP клиенту в целях отладки. В файле конфигурации показаны следующие основные шаги по добавлению поддержки функциональных возможностей ServiceDebugBehavior:

• ServiceDebugBehavior Так как тип является реализациейSystem.ServiceModel.Description.IServiceBehavior, элемент службы>,< представляющий тип службы, имеет идентификатор конфигурации behaviorConfiguration="metadataAndDebug"поведения .

• Опять же, поскольку ServiceDebugBehavior тип является реализацией System.ServiceModel.Description.IServiceBehavior<, элемент поведения> добавляется в <раздел serviceBehaviors> . Атрибут name<элемента поведения> , значение которого является идентификатором behaviorConfiguration атрибута <элемента службы> . В этом случае используется значение metadataAndDebug.

• Добавьте <элемент serviceDebug> с различными атрибутами, заданными в нужной конфигурации. В этом случае значения атрибута httpHelpPageEnabled и includeExceptionDetailInFaults заданы как 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>

Комментарии

Задайте для свойства HttpHelpPageEnabled значение false, чтобы отключить публикацию справочной HTML-страницы, видимую для HTML-браузеров.

Чтобы гарантировать, что справочная HTML-страница будет размещена по адресу, указанному в свойстве HttpsHelpPageUrl, необходимо установить для данного свойства значение true; при этом должно выполняться одно из следующих условий:

• Свойство HttpsHelpPageUrl должно представлять собой абсолютный адрес, который поддерживает схему протокола HTTP.

• Имеется базовый адрес для службы, которая поддерживает схему протокола HTTP.

Хотя создается исключение в тому случае, когда свойству HttpsHelpPageUrl присваивается абсолютный адрес, который не поддерживает схему протокола HTTP, при любом другом сценарии, в котором не удовлетворяется ни одно из указанных выше условий, исключение создаваться не будет, также не будет создаваться справочная HTML-страница.