FaultException 類別

定義

表示 SOAP 錯誤。Represents a SOAP fault.

public ref class FaultException : System::ServiceModel::CommunicationException
public class FaultException : System.ServiceModel.CommunicationException
[System.Runtime.Serialization.KnownType(typeof(System.ServiceModel.FaultException/FaultCodeData[]))]
[System.Runtime.Serialization.KnownType(typeof(System.ServiceModel.FaultException/FaultReasonData[]))]
[System.Runtime.Serialization.KnownType(typeof(System.ServiceModel.FaultException/FaultCodeData))]
[System.Runtime.Serialization.KnownType(typeof(System.ServiceModel.FaultException/FaultReasonData))]
[System.Serializable]
public class FaultException : System.ServiceModel.CommunicationException
[System.Serializable]
public class FaultException : System.ServiceModel.CommunicationException
type FaultException = class
    inherit CommunicationException
Public Class FaultException
Inherits CommunicationException
繼承
繼承
衍生
屬性

範例

下列程式碼範例示範如何使用 try/catch 區塊來攔截並處理從服務擲回的 FaultException 物件。The following code example shows the use of a try/catch block to catch and handle FaultException objects thrown from a service. 當服務應用程式開啟偵錯時,常會發生此情況。This often occurs when debugging is turned on in the service application.

using System;
using System.ServiceModel;
using System.ServiceModel.Channels;
using Microsoft.WCF.Documentation;

public class Client
{
  public static void Main()
  {
    // Picks up configuration from the configuration file.
    SampleServiceClient wcfClient = new SampleServiceClient();
    try
    {
      // Making calls.
      Console.WriteLine("Enter the greeting to send: ");
      string greeting = Console.ReadLine();
      Console.WriteLine("The service responded: " + wcfClient.SampleMethod(greeting));
      Console.WriteLine("Press ENTER to exit:");
      Console.ReadLine();
    }
    catch (TimeoutException timeProblem)
    {
      Console.WriteLine("The service operation timed out. " + timeProblem.Message);
      wcfClient.Abort();
      Console.ReadLine();
    }
    // Catch the contractually specified SOAP fault raised here as an exception.
    catch (FaultException<GreetingFault> greetingFault)
    {
      Console.WriteLine(greetingFault.Detail.Message);
      Console.Read();
      wcfClient.Abort();
    }
    // Catch unrecognized faults. This handler receives exceptions thrown by WCF
    // services when ServiceDebugBehavior.IncludeExceptionDetailInFaults
    // is set to true.
    catch (FaultException faultEx)
    {
      Console.WriteLine("An unknown exception was received. "
        + faultEx.Message
        + faultEx.StackTrace
      );
      Console.Read();
      wcfClient.Abort();
    }
    // Standard communication fault handler.
    catch (CommunicationException commProblem)
    {
      Console.WriteLine("There was a communication problem. " + commProblem.Message + commProblem.StackTrace);
      Console.Read();
      wcfClient.Abort();
    }
  }
}

Imports System.ServiceModel
Imports System.ServiceModel.Channels
Imports Microsoft.WCF.Documentation

Public Class Client
  Public Shared Sub Main()
    ' Picks up configuration from the configuration file.
    Dim wcfClient As New SampleServiceClient()
    Try
      ' Making calls.
      Console.WriteLine("Enter the greeting to send: ")
      Dim greeting As String = Console.ReadLine()
      Console.WriteLine("The service responded: " & wcfClient.SampleMethod(greeting))
      Console.WriteLine("Press ENTER to exit:")
      Console.ReadLine()
    Catch timeProblem As TimeoutException
      Console.WriteLine("The service operation timed out. " & timeProblem.Message)
      wcfClient.Abort()
      Console.ReadLine()
    ' Catch the contractually specified SOAP fault raised here as an exception.
    Catch greetingFault As FaultException(Of GreetingFault)
      Console.WriteLine(greetingFault.Detail.Message)
      Console.Read()
      wcfClient.Abort()
    ' Catch unrecognized faults. This handler receives exceptions thrown by WCF
    ' services when ServiceDebugBehavior.IncludeExceptionDetailInFaults 
    ' is set to true.
    Catch faultEx As FaultException
      Console.WriteLine("An unknown exception was received. " & faultEx.Message + faultEx.StackTrace)
      Console.Read()
      wcfClient.Abort()
    ' Standard communication fault handler.
    Catch commProblem As CommunicationException
      Console.WriteLine("There was a communication problem. " & commProblem.Message + commProblem.StackTrace)
      Console.Read()
      wcfClient.Abort()
    End Try
  End Sub
End Class

備註

在服務中,使用 FaultException 類別建立一個不具型別的錯誤,將它傳回至用戶端以進行偵錯之用。In a service, use the FaultException class to create an untyped fault to return to the client for debugging purposes.

在用戶端攔截 FaultException 物件來處理未知或一般錯誤,例如將 IncludeExceptionDetailInFaults 屬性設為 true 的服務所傳回的錯誤。In a client, catch FaultException objects to handle unknown or generic faults, such as those returned by a service with the IncludeExceptionDetailInFaults property set to true. 因為 FaultException 延伸了 CommunicationException,請記得在攔截 FaultExceptionCommunicationException物件之前先攔截 {5} 物件,才能分別攔截它們。Because FaultException extends CommunicationException, remember to catch any FaultException objects prior to catching CommunicationException objects if you want to catch them separately.

注意

雙工服務亦可攔截與雙工用戶端互動時,所傳回的 FaultException 物件。Duplex services can also catch FaultException objects returned from their interaction with a duplex client.

一般而言,若您決定用戶端需要錯誤資訊,則強烈建議您使用 FaultContractAttribute 來設計服務,以對所有錯誤情況傳回強型別 SOAP 錯誤 (以及未管理例外狀況物件)。In general, it is strongly recommended that you use the FaultContractAttribute to design your services to return strongly-typed SOAP faults (and not managed exception objects) for all fault cases in which you decide the client requires fault information. 但遇到下列狀況時,請使用 FaultExceptionHowever, use the FaultException in the following situations:

  • 從服務傳送 SOAP 錯誤以進行偵錯。To send SOAP faults from a service for debugging purposes.

  • 若該錯誤不是服務合約的一部分時,在用戶端攔截 SOAP 錯誤。To catch SOAP faults on a client when the faults are not part of the service contract.

當您想將該字串傳給建構函式,以及讓用戶端結取該字串時 (藉由呼叫 FaultExceptionFaultException<TDetail>.ToString方法),擲回 {3} 物件。Throw FaultException objects when you want the string to be passed to the constructor and retrieved by the client by calling the FaultException<TDetail>.ToString method. 若您指定一個 System.ServiceModel.FaultException<TDetail> 型別的錯誤合約,且型別參數為 System.String,則字串值可以 FaultException<TDetail>.Detail 屬性取得,而不是呼叫 FaultException<TDetail>.ToStringIf you specify a fault contract of type System.ServiceModel.FaultException<TDetail> where the type parameter is System.String, the string value is available as the FaultException<TDetail>.Detail property and not by calling FaultException<TDetail>.ToString.

如需詳細資訊,請參閱指定和處理合約和服務中的錯誤For details, see Specifying and Handling Faults in Contracts and Services.

建構函式

FaultException()

FaultException 類別的新執行個體初始化。Initializes a new instance of the FaultException class.

FaultException(FaultReason)

使用指定原因,初始化 FaultException 類別的新執行個體。Initializes a new instance of the FaultException class using the specified reason.

FaultException(FaultReason, FaultCode)

使用指定的原因與錯誤碼,初始化 FaultException 類別的新執行個體。Initializes a new instance of the FaultException class using the specified reason and fault code.

FaultException(FaultReason, FaultCode, String)

使用指定的原因、錯誤碼與動作值,初始化 FaultException 類別的新執行個體。Initializes a new instance of the FaultException class using the specified reason, fault code, and action value.

FaultException(MessageFault)

使用指定的訊息錯誤值,初始化 FaultException 類別的新執行個體。Initializes a new instance of the FaultException class using the specified message fault values.

FaultException(MessageFault, String)

使用指定的訊息錯誤值與提供的動作字串,初始化 FaultException 類別的執行個體。Initializes a new instance of the FaultException class using the specified message fault values and the provided action string.

FaultException(SerializationInfo, StreamingContext)

將資料流還原序列化至 FaultException 物件時,使用指定的序列化資訊和內容,初始化 FaultException 類別的新執行個體。Initializes a new instance of the FaultException class using the specified serialization information and context when deserializing a stream into a FaultException object.

FaultException(String)

使用指定的錯誤原因,初始化 FaultException 類別的新執行個體。Initializes a new instance of the FaultException class with the specified fault reason.

FaultException(String, FaultCode)

使用指定的原因與 SOAP 錯誤碼,初始化 FaultException 類別的新執行個體。Initializes a new instance of the FaultException class using the specified reason and SOAP fault code.

FaultException(String, FaultCode, String)

使用指定的原因、錯誤碼與動作值,初始化 FaultException 類別的新執行個體。Initializes a new instance of the FaultException class using the specified reason, fault code, and action value.

屬性

Action

取得錯誤訊息的 SOAP 動作值。Gets the value of the SOAP action for the fault message.

Code

取得 SOAP 錯誤的錯誤碼。Gets the fault code for the SOAP fault.

Data

取得提供例外狀況之其他使用者定義相關資訊的索引鍵/值組集合。Gets a collection of key/value pairs that provide additional user-defined information about the exception.

(繼承來源 Exception)
HelpLink

取得或設定與這個例外狀況相關聯的說明檔連結。Gets or sets a link to the help file associated with this exception.

(繼承來源 Exception)
HResult

取得或設定 HRESULT,它是指派給特定例外狀況的編碼數值。Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.

(繼承來源 Exception)
InnerException

取得造成目前例外狀況的 Exception 執行個體。Gets the Exception instance that caused the current exception.

(繼承來源 Exception)
Message

取得例外狀況的訊息。Gets the message for the exception.

Reason

取得 SOAP 錯誤的 FaultReasonGets the FaultReason for the SOAP fault.

Source

取得或設定造成錯誤的應用程式或物件的名稱。Gets or sets the name of the application or the object that causes the error.

(繼承來源 Exception)
StackTrace

取得呼叫堆疊上即時運算框架的字串表示。Gets a string representation of the immediate frames on the call stack.

(繼承來源 Exception)
TargetSite

取得擲回目前例外狀況的方法。Gets the method that throws the current exception.

(繼承來源 Exception)

方法

CreateFault(MessageFault, String, Type[])

從指定的訊息錯誤、動作與一個詳細型別陣列,傳回一個 FaultException 物件。Returns a FaultException object from the specified message fault, action and an array of detail types.

CreateFault(MessageFault, Type[])

從指定的訊息錯誤與一個詳細型別陣列,傳回一個 FaultException 物件。Returns a FaultException object from the specified message fault and an array of detail types.

CreateMessageFault()

傳回 MessageFault 物件。Returns a MessageFault object.

Equals(Object)

Determines whether the specified object is equal to the current object.Determines whether the specified object is equal to the current object.

(繼承來源 Object)
GetBaseException()

在衍生類別中覆寫時,傳回一或多個後續的例外狀況的根本原因 ExceptionWhen overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.

(繼承來源 Exception)
GetHashCode()

Serves as the default hash function.Serves as the default hash function.

(繼承來源 Object)
GetObjectData(SerializationInfo, StreamingContext)

GetObjectData(SerializationInfo, StreamingContext) 方法的實作,當物件序列化成資料流時,會呼叫此方法。Implementation of the GetObjectData(SerializationInfo, StreamingContext) method that is called when the object is serialized into a stream.

GetObjectData(SerializationInfo, StreamingContext)

在衍生類別中覆寫時,使用例外狀況的資訊設定 SerializationInfoWhen overridden in a derived class, sets the SerializationInfo with information about the exception.

(繼承來源 Exception)
GetType()

取得目前執行個體的執行階段類型。Gets the runtime type of the current instance.

(繼承來源 Exception)
MemberwiseClone()

Creates a shallow copy of the current Object.Creates a shallow copy of the current Object.

(繼承來源 Object)
ToString()

建立並傳回目前例外狀況的字串表示。Creates and returns a string representation of the current exception.

(繼承來源 Exception)

事件

SerializeObjectState

當例外狀況序列化,以建立包含例外狀況相關序列化資料的例外狀況狀態物件時,就會發生此事件。Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.

(繼承來源 Exception)

適用於