ServiceDebugBehavior.IncludeExceptionDetailInFaults ServiceDebugBehavior.IncludeExceptionDetailInFaults ServiceDebugBehavior.IncludeExceptionDetailInFaults ServiceDebugBehavior.IncludeExceptionDetailInFaults Property

定義

デバッグの目的でクライアントに返される SOAP エラーの詳細に、マネージド例外情報を含めるかどうかを指定する値を取得または設定します。Gets or sets a value that specifies whether to include managed exception information in the detail of SOAP faults returned to the client for debugging purposes.

public:
 property bool IncludeExceptionDetailInFaults { bool get(); void set(bool value); };
public bool IncludeExceptionDetailInFaults { get; set; }
member this.IncludeExceptionDetailInFaults : bool with get, set
Public Property IncludeExceptionDetailInFaults As Boolean

プロパティ値

trueWindows Communication Foundation (WCF) の場合、クライアントのデバッグのために SOAP エラーのマネージ例外情報が返されます。それ以外falseの場合は。true if Windows Communication Foundation (WCF) returns managed exception information in the SOAP faults for client debugging purposes; otherwise, false. 既定値は、false です。The default is false.

構成ファイルを使用して、HTML ヘルプ ページ機能を有効にし、デバッグのために SOAP エラー内の例外情報をクライアントに返す方法を次のコード例に示します。The following code example shows how to use a configuration file to enable the HTML help page feature and return exception information inside a SOAP fault back to the client for debugging purposes. この構成ファイルは、ServiceDebugBehavior 機能のサポートを追加するための次の基本手順を示します。This configuration file shows the following basic steps to adding support for the ServiceDebugBehavior features:

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

注釈

デバッグを容易にtrueするために、プロパティをに設定して、WCFにマネージ例外情報をSOAPエラーでクライアントに返すように指示します。IncludeExceptionDetailInFaultsSet the IncludeExceptionDetailInFaults property to true to instruct WCF to return managed exception information to the client in SOAP faults to ease debugging.

注意事項

マネージド例外情報をクライアントに戻すことは、セキュリティ リスクになり得ます。これは、例外の詳細が、非承認のクライアントで使用可能な内部サービスの実装についての情報を公開するからです。Returning managed exception information to clients can be a security risk because exception details expose information about the internal service implementation that could be used by unauthorized clients. さらに、ServiceDebugBehavior プロパティをプログラムで設定することはできますが、配置するときに IncludeExceptionDetailInFaults を無効にすることを忘れがちになります。In addition, although the ServiceDebugBehavior properties can also be set programmatically, it can be easy to forget to disable IncludeExceptionDetailInFaults when deploying.

セキュリティの問題にかかわるので、以下を強くお勧めします。Because of the security issues involved, it is strongly recommended that:

  • IncludeExceptionDetailInFaults プロパティの値を true に設定するには、アプリケーション構成ファイルを使用します。You use an application configuration file to set the value of the IncludeExceptionDetailInFaults property to true.

  • これは、制御されたデバッグ シナリオの場合に限って行います。You only do so only in controlled debugging scenarios.

詳細については、「コントラクトとサービスのエラーの指定と処理」を参照してください。For more information, see Specifying and Handling Faults in Contracts and Services.

適用対象