語言

ServiceDebugElement 類別

定義

代表一個設定元素,指定 Windows 通訊基金會(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
繼承
繼承

範例

以下程式碼範例說明如何利用設定檔啟用 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 程式化,即可啟用管理異常資訊流向用戶端以便除錯,並發布 HTML 資訊檔案,供網頁瀏覽器瀏覽服務的使用者使用。

注意事項

將受管理異常資訊回傳給服務可能構成安全風險。 這是因為例外細節會揭露內部客戶端實作的資訊,這些資訊可能會被未經授權的服務使用。

HttpHelpPageEnabled與HttpsHelpPageEnabled屬性指示服務在使用 HTML 瀏覽器查看服務時發布 HTML 說明檔案。

HttpHelpPageUrl和 HttpsHelpPageUrl 屬性控制被瀏覽的 HTML 說明頁面的位置。

要啟用或停用使用設定檔的某項 ServiceDebugElement 功能,您必須:

  1. 為你的 WCF 服務在behaviorConfiguration<屬性。 (端點行為在元素上設定;服務行為在<endpoint>配置<。)

  2. 新增或建立一個 <serviceBehaviors> 區塊,並在該區塊中加入<一個名稱與第 1 步屬性值相符的行為>元素。behaviorConfiguration (端點行為是透過 <endpointBehaviors> 元素配置;服務行為則是透過 <serviceBehaviors> 元素配置。

  3. 在第 2 步的行為<元素中加入 serviceDebug 元素>,並啟用或停用適合你情境的各種屬性。<>

具體例子請參見範例章節。

建構函式

名稱 Description
ServiceDebugElement()

初始化 ServiceDebugElement 類別的新執行個體。

屬性

名稱 Description
BehaviorType

了解這種行為元素的類型。

ConfigurationElementName

取得這個配置元素的名稱。

(繼承來源 ServiceModelExtensionElement)
CurrentConfiguration

取得最上層 Configuration 實例的參考,表示目前 ConfigurationElement 實例所屬的組態階層。

(繼承來源 ConfigurationElement)
ElementInformation

取得 ElementInformation 物件,其中包含 ConfigurationElement 物件的不可自定義資訊和功能。

(繼承來源 ConfigurationElement)
ElementProperty

取得代表 ConfigurationElementProperty 物件本身的 ConfigurationElement 物件。

(繼承來源 ConfigurationElement)
EvaluationContext

取得 ContextInformation 物件的 ConfigurationElement 物件。

(繼承來源 ConfigurationElement)
HasContext

取得值,這個值表示 CurrentConfiguration 屬性是否 null。

(繼承來源 ConfigurationElement)
HttpHelpPageBinding

取得或設定一個字串值,指定使用 HTTP 存取服務說明頁面時要使用的綁定。

HttpHelpPageBindingConfiguration

取得或設定一個字串,指向一個定義綁定 HttpHelpPageBinding的額外設定資訊的 XML 區段。

HttpHelpPageEnabled

取得或設定一個值,指示 Windows 通訊基金會(WCF)是否會在該 HttpHelpPageUrl 屬性指定的地址發布 HTML 說明頁面。

HttpHelpPageUrl

取得或設定 HTML 說明檔發佈的位置。

HttpsHelpPageBinding

取得或設定一個字串值,指定使用 HTTPS 存取服務說明頁面時要使用的綁定。

HttpsHelpPageBindingConfiguration

取得或設定一個字串,指向一個定義綁定 HttpsHelpPageBinding的額外設定資訊的 XML 區段。

HttpsHelpPageEnabled

取得或設定一個值,指定 Windows 通訊基金會(WCF)是否會透過 HTTPS 返回 HTML 說明檔,地址依據屬性 HttpsHelpPageUrl 指定。

HttpsHelpPageUrl

取得或設定 HTML 說明檔發佈的位置,並使用 HTTPS 檢索。

IncludeExceptionDetailInFaults

取得或設定一個值,指定是否在回傳給客戶端以供除錯目的的 SOAP 錯誤細節中包含受管理異常資訊。

Item[ConfigurationProperty]

取得或設定這個組態項目的屬性或屬性。

(繼承來源 ConfigurationElement)
Item[String]

取得或設定這個組態專案的屬性、屬性或子專案。

(繼承來源 ConfigurationElement)
LockAllAttributesExcept

取得鎖定屬性的集合。

(繼承來源 ConfigurationElement)
LockAllElementsExcept

取得鎖定專案的集合。

(繼承來源 ConfigurationElement)
LockAttributes

取得鎖定屬性的集合。

(繼承來源 ConfigurationElement)
LockElements

取得鎖定專案的集合。

(繼承來源 ConfigurationElement)
LockItem

取得或設定值,指出專案是否已鎖定。

(繼承來源 ConfigurationElement)
Properties

取得屬性的集合。

(繼承來源 ConfigurationElement)

方法

名稱 Description
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()

設定 IsReadOnly() 物件及所有子元素的 ConfigurationElement 屬性。

(繼承來源 ConfigurationElement)
ToString()

傳回表示目前 物件的字串。

(繼承來源 Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

修改物件 ConfigurationElement 以移除所有不應儲存的值。

(繼承來源 ConfigurationElement)

適用於

另請參閱