ServiceDebugElement 类

参考

定义

命名空间:: System.ServiceModel.Configuration

程序集:: System.ServiceModel.dll

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

表示一个配置元素，该元素指定 Windows Communication Foundation (WCF) 服务的调试和帮助信息功能。此类不能被继承。

public ref class ServiceDebugElement sealed : System::ServiceModel::Configuration::BehaviorExtensionElement

public sealed class ServiceDebugElement : System.ServiceModel.Configuration.BehaviorExtensionElement

type ServiceDebugElement = class
    inherit BehaviorExtensionElement

Public NotInheritable Class ServiceDebugElement
Inherits BehaviorExtensionElement

继承: Object

ConfigurationElement

ServiceModelExtensionElement

BehaviorExtensionElement
ServiceDebugElement

继承: Object

ConfigurationElement

ServiceModelConfigurationElement

ServiceModelExtensionElement

BehaviorExtensionElement
ServiceDebugElement

示例

下面的代码示例演示如何使用配置文件来启用 HTML 帮助页功能，并将 SOAP 错误内部的异常信息返回到客户端以便进行调试（另外还启用元数据支持）。

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

注解

如果以编程方式将 IncludeExceptionDetailInFaults 属性设置为 true，则可以将托管异常信息流到客户端以便进行调试，还可以向在 Web 浏览器中浏览该服务的用户发布 HTML 信息文件。

注意

向服务返回托管异常信息可能具有安全风险。这是因为，异常详细信息公开了有关内部客户端实现的信息，这些信息可能被未经授权的服务使用。

当使用 HTML 浏览器查看服务时，HttpHelpPageEnabled 和 HttpsHelpPageEnabled 属性指示服务发布 HTML 帮助文件。

HttpHelpPageUrl 和 HttpsHelpPageUrl 属性控制所查看的 HTML 帮助页的位置。

若要使用配置文件启用或禁用其中一个 ServiceDebugElement 功能，必须：

将 behaviorConfiguration 特性添加到 <WCF 服务的 service> 元素。 (终结点行为是在元素上 <endpoint> 配置的;服务元素上的 <服务> 行为。)
将添加到或创建 <serviceBehaviors> 节，并在其中添加一个<行为>元素，其名称与步骤 1 中的behaviorConfiguration属性值匹配。 (终结点行为是使用 <endpointBehaviors> 元素配置的;服务行为是使用 <serviceBehaviors> 元素配置的。
将 <serviceDebug> 元素添加到步骤 2 中的 <behavior> 元素，并启用或禁用适合你的方案的各种属性。

有关具体示例的信息，请参见“示例”部分。

构造函数

ServiceDebugElement()

初始化 ServiceDebugElement 类的新实例。

属性

BehaviorType	获取此行为元素的类型。
ConfigurationElementName	获取此配置元素的名称。 (继承自 ServiceModelExtensionElement)
CurrentConfiguration	获取对顶级 Configuration 实例的引用，该实例表示当前 ConfigurationElement 实例所属的配置层次结构。 (继承自 ConfigurationElement)
ElementInformation	获取包含 ConfigurationElement 对象的不可自定义的信息和功能的 ElementInformation 对象。 (继承自 ConfigurationElement)
ElementProperty	获取表示 ConfigurationElement 对象本身的 ConfigurationElementProperty 对象。 (继承自 ConfigurationElement)
EvaluationContext	获取 ConfigurationElement 对象的 ContextInformation 对象。 (继承自 ConfigurationElement)
HasContext	获取一个值，该值指示 CurrentConfiguration 属性是否为 `null`。 (继承自 ConfigurationElement)
HttpHelpPageBinding	获取或设置一个字符串值，指定利用 HTTP 访问服务帮助页时使用绑定。
HttpHelpPageBindingConfiguration	获取或设置一个指向 XML 节的字符串，该 XML 节定义 HttpHelpPageBinding 中指定的绑定的附加配置信息。
HttpHelpPageEnabled	获取或设置一个值，该值指示 Windows Communication Foundation (WCF) 是否在由 HttpHelpPageUrl 属性指定的地址发布 HTML 帮助页。
HttpHelpPageUrl	获取或设置发布 HTML 帮助文件的位置。
HttpsHelpPageBinding	获取或设置一个字符串值，指定利用 HTTPS 访问服务帮助页时使用绑定。
HttpsHelpPageBindingConfiguration	获取或设置一个指向 XML 节的字符串，该 XML 节定义 HttpsHelpPageBinding 中指定的绑定的附加配置信息。
HttpsHelpPageEnabled	获取或设置一个值，该值指定 Windows Communication Foundation (WCF) 是否在由 HttpsHelpPageUrl 属性指定的地址通过 HTTPS 返回 HTML 帮助文件。
HttpsHelpPageUrl	获取或设置发布 HTML 帮助文件以便使用 HTTPS 进行帮助的位置。
IncludeExceptionDetailInFaults	获取或设置一个值，该值指定在返回客户端以供调试的 SOAP 错误详细信息中是否包含托管异常信息。
Item[ConfigurationProperty]	获取或设置此配置元素的属性或特性。 (继承自 ConfigurationElement)
Item[String]	获取或设置此配置元素的属性、特性或子元素。 (继承自 ConfigurationElement)
LockAllAttributesExcept	获取被锁定的特性的集合。 (继承自 ConfigurationElement)
LockAllElementsExcept	获取被锁定的元素的集合。 (继承自 ConfigurationElement)
LockAttributes	获取被锁定的特性的集合。 (继承自 ConfigurationElement)
LockElements	获取被锁定的元素的集合。 (继承自 ConfigurationElement)
LockItem	获取或设置一个值，该值指示是否已锁定该元素。 (继承自 ConfigurationElement)
Properties	获取属性的集合。 (继承自 ConfigurationElement)

方法

CopyFrom(ServiceModelExtensionElement)	将指定配置元素的内容复制到此配置元素。
CreateBehavior()	基于当前配置设置来创建行为扩展。 (继承自 BehaviorExtensionElement)
DeserializeElement(XmlReader, Boolean)	从配置文件读取 XML。 (继承自 ConfigurationElement)
Equals(Object)	将当前的 ConfigurationElement 实例与指定的对象进行比较。 (继承自 ConfigurationElement)
GetHashCode()	获取表示当前 ConfigurationElement 实例的唯一值。 (继承自 ConfigurationElement)
GetTransformedAssemblyString(String)	返回指定程序集名称的转换版本。 (继承自 ConfigurationElement)
GetTransformedTypeString(String)	返回指定类型名称的转换版本。 (继承自 ConfigurationElement)
GetType()	获取当前实例的 Type。 (继承自 Object)
Init()	将 ConfigurationElement 对象设置为其初始状态。 (继承自 ConfigurationElement)
InitializeDefault()	用于初始化 ConfigurationElement 对象的默认值集。 (继承自 ConfigurationElement)
IsModified()	获取一个值，该值指定此配置元素是否已修改。 (继承自 ServiceModelExtensionElement)
IsReadOnly()	获取一个值，该值指示 ConfigurationElement 对象是否为只读。 (继承自 ConfigurationElement)
ListErrors(IList)	将此 ConfigurationElement 对象以及所有子元素中无效属性的错误添加到传递的列表中。 (继承自 ConfigurationElement)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
OnDeserializeUnrecognizedAttribute(String, String)	获取一个值，该值指示反序列化过程中是否遇到未知特性。 (继承自 ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	获取一个值，该值指示反序列化过程中是否遇到未知元素。 (继承自 ConfigurationElement)
OnRequiredPropertyNotFound(String)	找不到所需属性时引发异常。 (继承自 ConfigurationElement)
PostDeserialize()	反序列化后调用。 (继承自 ConfigurationElement)
PreSerialize(XmlWriter)	在序列化之前调用。 (继承自 ConfigurationElement)
Reset(ConfigurationElement)	重置此配置元素对象的内部状态，包括锁定和属性集合。 (继承自 ServiceModelExtensionElement)
ResetModified()	在派生类中实现时，将 IsModified() 方法的值重置为 `false`。 (继承自 ConfigurationElement)
SerializeElement(XmlWriter, Boolean)	将此配置元素的内容写入配置文件。 (继承自 ServiceModelExtensionElement)
SerializeToXmlElement(XmlWriter, String)	当在派生类中实现后，将此配置元素的外部标记写入配置文件。 (继承自 ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	将属性设置为指定值。 (继承自 ConfigurationElement)
SetPropertyValueIfNotDefaultValue<T>(String, T)	如果值不是默认值，为配置元素设置属性值。 (继承自 ServiceModelConfigurationElement)
SetReadOnly()	设置 ConfigurationElement 对象及所有子元素的 IsReadOnly() 属性。 (继承自 ConfigurationElement)
ToString()	返回表示当前对象的字符串。 (继承自 Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	修改 ConfigurationElement 对象以移除所有不应该保存的值。 (继承自 ConfigurationElement)

适用于

另请参阅

<serviceDebug>

ServiceDebugElement 类

定义

示例

注解

构造函数

属性

方法

适用于

另请参阅

反馈

其他资源