ServiceDebugBehavior.HttpHelpPageEnabled プロパティ

定義

名前空間:

System.ServiceModel.Description

アセンブリ:

System.ServiceModel.dll

Windows Communication Foundation (WCF) が、HttpHelpPageUrl プロパティで制御されるアドレスに HTML ヘルプ ページを公開するかどうかを制御する値を取得または設定します。

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

WCF が HTML ヘルプ ページを公開する場合は true。それ以外の場合は false。 既定値は、true です。

例

構成ファイルを使用して、HTML ヘルプ ページ機能を有効にし、デバッグのために SOAP エラー内の例外情報をクライアントに返す方法を次のコード例に示します。 この構成ファイルは、ServiceDebugBehavior 機能のサポートを追加するための次の基本手順を示します。

• ServiceDebugBehavior型はSystem.ServiceModel.Description.IServiceBehavior実装であるため、サービスの種類を<表すサービス>要素の動作構成識別子behaviorConfiguration="metadataAndDebug"は です。

• この場合も、型はSystem.ServiceModel.Description.IServiceBehavior実装であるためServiceDebugBehavior、serviceBehaviors> セクションに<動作>要素が追加されます。< name behavior> 要素の<属性。 の値は、サービス>要素の属性の<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 ヘルプ ページの公開を無効にします。

HttpsHelpPageUrl プロパティで制御される場所で HTML ヘルプ ページを確実に公開するには、このプロパティを true に設定し、次のいずれかの条件も true である必要があります。

• HttpsHelpPageUrl プロパティは、HTTP プロトコル スキームをサポートする絶対アドレスです。

• HTTP プロトコル スキームをサポートするサービスのベース アドレスがあります。

HTTP プロトコル スキームをサポートしない絶対アドレスが HttpsHelpPageUrl プロパティに割り当てられている場合は例外がスローされますが、前の基準をどれも満たさないその他のシナリオでは、例外も HTML ヘルプ ページも表示されません。