FaultException<TDetail> クラス

定義

コントラクトで指定された SOAP エラーをキャッチするためにクライアント アプリケーションで使用されます。Used in a client application to catch contractually-specified SOAP faults.

generic <typename TDetail>
public ref class FaultException : System::ServiceModel::FaultException
public class FaultException<TDetail> : System.ServiceModel.FaultException
[System.Serializable]
public class FaultException<TDetail> : System.ServiceModel.FaultException
type FaultException<'Detail> = class
    inherit FaultException
[<System.Serializable>]
type FaultException<'Detail> = class
    inherit FaultException
Public Class FaultException(Of TDetail)
Inherits FaultException

型パラメーター

TDetail

シリアル化可能なエラーの詳細な型。The serializable error detail type.

継承
継承
派生
属性

次のコード例では、FaultException<TDetail> により指定された SOAP エラーに変換されるマネージド例外をスローするために、サービスが FaultContractAttribute 型を使用する方法を示しています。The following code example shows how a service uses the FaultException<TDetail> type to throw a managed exception that gets converted into the SOAP fault specified by the FaultContractAttribute.

using System;
using System.Collections.Generic;
using System.Net.Security;
using System.Runtime.Serialization;
using System.ServiceModel;
using System.Text;

namespace Microsoft.WCF.Documentation
{
  [ServiceContract(Namespace="http://microsoft.wcf.documentation")]
  public interface ISampleService{
    [OperationContract]
    [FaultContractAttribute(
      typeof(GreetingFault),
      Action="http://www.contoso.com/GreetingFault",
      ProtectionLevel=ProtectionLevel.EncryptAndSign
      )]
    string SampleMethod(string msg);
  }

  [DataContractAttribute]
  public class GreetingFault
  {
    private string report;

    public GreetingFault(string message)
    {
      this.report = message;
    }

    [DataMemberAttribute]
    public string Message
    {
      get { return this.report; }
      set { this.report = value; }
    }
  }

  class SampleService : ISampleService
  {
  #region ISampleService Members

  public string  SampleMethod(string msg)
  {
    Console.WriteLine("Client said: " + msg);
    // Generate intermittent error behavior.
    Random rnd = new Random(DateTime.Now.Millisecond);
    int test = rnd.Next(5);
    if (test % 2 != 0)
      return "The service greets you: " + msg;
    else
      throw new FaultException<GreetingFault>(new GreetingFault("A Greeting error occurred. You said: " + msg));
  }

  #endregion
  }
}

Imports System.Collections.Generic
Imports System.Net.Security
Imports System.Runtime.Serialization
Imports System.ServiceModel
Imports System.Text

Namespace Microsoft.WCF.Documentation
  <ServiceContract(Namespace:="http://microsoft.wcf.documentation")> _
  Public Interface ISampleService
    <OperationContract, FaultContractAttribute(GetType(GreetingFault), Action:="http://www.contoso.com/GreetingFault", ProtectionLevel:=ProtectionLevel.EncryptAndSign)> _
    Function SampleMethod(ByVal msg As String) As String
  End Interface

  <DataContractAttribute> _
  Public Class GreetingFault
    Private report As String

    Public Sub New(ByVal message As String)
      Me.report = message
    End Sub

    <DataMemberAttribute> _
    Public Property Message() As String
      Get
          Return Me.report
      End Get
      Set(ByVal value As String)
          Me.report = value
      End Set
    End Property
  End Class

  Friend Class SampleService
      Implements ISampleService
  #Region "ISampleService Members"

  Public Function SampleMethod(ByVal msg As String) As String Implements ISampleService.SampleMethod
    Console.WriteLine("Client said: " & msg)
    ' Generate intermittent error behavior.
    Dim rand As New Random(DateTime.Now.Millisecond)
    Dim test As Integer = rand.Next(5)
    If test Mod 2 <> 0 Then
      Return "The service greets you: " & msg
    Else
      Throw New FaultException(Of GreetingFault)(New GreetingFault("A Greeting error occurred. You said: " & msg))
    End If
  End Function

  #End Region
  End Class
End Namespace

次のコード例では、 ServiceModel メタデータユーティリティツール (Svcutil.exe)を使用してクライアントによってインポートされた場合に、クライアントコードがどのように表示されるかを示します。The following code example shows how the client code looks when imported by the client using the ServiceModel Metadata Utility Tool (Svcutil.exe).

次のコード例は、操作コントラクト内に指定されたカスタム SOAP エラーを表す FaultException<TDetail> 型をクライアントがキャッチできる方法を示しています。The following code example shows how a client can catch the FaultException<TDetail> type that represents the custom SOAP fault specified in the operation contract.

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 config 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();

      // Done with service.
      wcfClient.Close();
      Console.WriteLine("Done!");
    }
    catch (TimeoutException timeProblem)
    {
      Console.WriteLine("The service operation timed out. " + timeProblem.Message);
      Console.ReadLine();
      wcfClient.Abort();
    }
    catch (FaultException<GreetingFault> greetingFault)
    {
      Console.WriteLine(greetingFault.Detail.Message);
      Console.ReadLine();
      wcfClient.Abort();
    }
    catch (FaultException unknownFault)
    {
      Console.WriteLine("An unknown exception was received. " + unknownFault.Message);
      Console.ReadLine();
      wcfClient.Abort();
    }
    catch (CommunicationException commProblem)
    {
      Console.WriteLine("There was a communication problem. " + commProblem.Message + commProblem.StackTrace);
      Console.ReadLine();
      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 config 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()

      ' Done with service. 
      wcfClient.Close()
      Console.WriteLine("Done!")
    Catch timeProblem As TimeoutException
      Console.WriteLine("The service operation timed out. " & timeProblem.Message)
      Console.ReadLine()
      wcfClient.Abort()
    Catch greetingFault As FaultException(Of GreetingFault)
      Console.WriteLine(greetingFault.Detail.Message)
      Console.ReadLine()
      wcfClient.Abort()
    Catch unknownFault As FaultException
      Console.WriteLine("An unknown exception was received. " & unknownFault.Message)
      Console.ReadLine()
      wcfClient.Abort()
    Catch commProblem As CommunicationException
      Console.WriteLine("There was a communication problem. " & commProblem.Message + commProblem.StackTrace)
      Console.ReadLine()
      wcfClient.Abort()
    End Try
  End Sub
End Class

注釈

FaultException<TDetail>Windows Communication Foundation (WCF) クライアントアプリケーションでオブジェクトをキャッチして、操作コントラクトで契約に指定されている SOAP エラーを処理します。Catch the FaultException<TDetail> object in a Windows Communication Foundation (WCF) client application to handle a SOAP fault that has been contractually specified in an operation contract.

通常使用されるサービスでは、FaultContractAttribute を使用して、通常の操作中に受信することをクライアントが予期できるすべての SOAP エラーを正式に指定します。Typical deployed services use the FaultContractAttribute to formally specify all SOAP faults that a client can expect to receive in the normal course of an operation. 内のエラー情報はと FaultContractAttribute して表示され FaultException<TDetail> ます (typeparameter は操作のに指定されたシリアル化可能なエラーオブジェクトで、 FaultContractAttribute クライアントアプリケーションに到達した場合)。Error information in a FaultContractAttribute appears as a FaultException<TDetail> (where the typeparameter is the serializable error object specified in the operation's FaultContractAttribute) when it arrives at a client application. FaultContractAttribute を使用して、双方向サービス メソッドと非同期メソッド ペアの SOAP エラーを両方とも指定できます。The FaultContractAttribute can be used to specify SOAP faults for both two-way service methods and for asynchronous method pairs.

FaultException<TDetail>FaultException であり、したがって CommunicationException でもあるので、指定された SOAP エラーをキャッチするには、FaultException<TDetail> 型と FaultException 型をキャッチする前に CommunicationException 型を必ずキャッチするか、指定された例外を例外ハンドラーのいずれかで必ず処理します。Because FaultException<TDetail> is both a FaultException and therefore a CommunicationException, to catch specified SOAP faults make sure you catch the FaultException<TDetail> types prior to the FaultException and CommunicationException types or handle the specified exceptions in one of those exception handlers.

注意

System.ServiceModel.FaultContractAttribute を使用して、型パラメーターが FaultException<TDetail> である System.String を指定した場合、クライアント アプリケーションでは文字列値に Detail プロパティが割り当てられ、クライアントは FaultException<TDetail>.ToString メソッドを呼び出してもその文字列を取得できません。If you use System.ServiceModel.FaultContractAttribute to specify a FaultException<TDetail> where the type parameter is a System.String, the string value is assigned to the Detail property in the client application; clients cannot retrieve that string by calling the FaultException<TDetail>.ToString method. クライアント アプリケーションが Exception.ToString を呼び出したときにこの文字列値を返すには、操作内で System.ServiceModel.FaultException 例外をスローし、この文字列をコンストラクターに渡します。To have the string value returned when the client application calls Exception.ToString, throw a System.ServiceModel.FaultException exception inside the operation and pass the string to the constructor.
通常は、詳細な型はエラーに適したシリアル化可能なカスタム型にし、System.String にはしないことをお勧めします。In general, it is recommended that detail types be custom serializable types appropriate to the fault and not a System.String.

コンストラクター

FaultException<TDetail>(SerializationInfo, StreamingContext)

ストリームを FaultException<TDetail> オブジェクトに逆シリアル化するときに、指定したシリアル化情報とコンテキストを使用して、FaultException クラスの新しいインスタンスを初期化します。Initializes a new instance of the FaultException<TDetail> class using the specified serialization information and context when deserializing a stream into a FaultException object.

FaultException<TDetail>(TDetail)

指定した詳細オブジェクトを使用する、FaultException<TDetail> クラスの新しいインスタンスを初期化します。Initializes a new instance of the FaultException<TDetail> class that uses the specified detail object.

FaultException<TDetail>(TDetail, FaultReason)

指定した詳細オブジェクトとエラー理由を使用する、FaultException<TDetail> クラスの新しいインスタンスを初期化します。Initializes a new instance of the FaultException<TDetail> class that uses the specified detail object and fault reason.

FaultException<TDetail>(TDetail, FaultReason, FaultCode)

指定した詳細オブジェクト、エラー理由、およびエラー コードを使用する、FaultException<TDetail> クラスの新しいインスタンスを初期化します。Initializes a new instance of the FaultException<TDetail> class that uses the specified detail object, fault reason, and fault code.

FaultException<TDetail>(TDetail, FaultReason, FaultCode, String)

指定した詳細オブジェクト、SOAP エラー理由、コード、およびアクション値を使用する、FaultException<TDetail> クラスの新しいインスタンスを初期化します。Initializes a new instance of the FaultException<TDetail> class that uses the specified detail object, and SOAP fault reason, code and action values.

FaultException<TDetail>(TDetail, String)

指定した詳細とエラー理由を使用する、FaultException<TDetail> クラスの新しいインスタンスを初期化します。Initializes a new instance of the FaultException<TDetail> class that uses the specified detail and fault reason.

FaultException<TDetail>(TDetail, String, FaultCode)

指定した詳細オブジェクト、エラー理由、およびエラー コードを使用する、FaultException<TDetail> クラスの新しいインスタンスを初期化します。Initializes a new instance of the FaultException<TDetail> class that uses the specified detail object, fault reason, and fault code.

FaultException<TDetail>(TDetail, String, FaultCode, String)

指定した詳細オブジェクト、SOAP エラー理由、コード、およびアクション値を使用する、FaultException<TDetail> クラスの新しいインスタンスを初期化します。Initializes a new instance of the FaultException<TDetail> class that uses the specified detail object, and SOAP fault reason, code and action values.

プロパティ

Action

エラー メッセージの SOAP アクションの値を取得します。Gets the value of the SOAP action for the fault message.

(継承元 FaultException)
Code

SOAP エラーのエラー コードを取得します。Gets the fault code for the SOAP fault.

(継承元 FaultException)
Data

例外に関する追加のユーザー定義情報を提供する、キーと値のペアのコレクションを取得します。Gets a collection of key/value pairs that provide additional user-defined information about the exception.

(継承元 Exception)
Detail

エラー状態の詳細情報を格納するオブジェクトを取得します。Gets the object that contains the detail information of the fault condition.

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.

(継承元 FaultException)
Reason

SOAP エラーの FaultReason を取得します。Gets the FaultReason for the SOAP fault.

(継承元 FaultException)
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)

メソッド

CreateMessageFault()

SOAP エラーを表す MessageFault を作成するために使用できる Message オブジェクトを作成します。Creates a MessageFault object that can be used to create a Message that represents the SOAP fault.

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetBaseException()

派生クラスでオーバーライドされた場合、それ以後に発生する 1 つ以上の例外の根本原因である Exception を返します。When 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.

(継承元 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)

オブジェクトがストリームにシリアル化されるときに呼び出される GetObjectData(SerializationInfo, StreamingContext) メソッドの実装です。Implementation of the GetObjectData(SerializationInfo, StreamingContext) method that is called when the object is serialized into a stream.

(継承元 FaultException)
GetType()

現在のインスタンスのランタイム型を取得します。Gets the runtime type of the current instance.

(継承元 Exception)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

FaultException<TDetail> オブジェクトの文字列を返します。Returns a string for the FaultException<TDetail> object.

イベント

SerializeObjectState

例外がシリアル化され、例外に関するシリアル化されたデータを含む例外状態オブジェクトが作成されたときに発生します。Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.

(継承元 Exception)

適用対象