FaultException<TDetail> クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
コントラクトで指定された SOAP エラーをキャッチするためにクライアント アプリケーションで使用されます。
generic <typename TDetail>
public ref class FaultException : System::ServiceModel::FaultExceptionpublic class FaultException<TDetail> : System.ServiceModel.FaultException[System.Runtime.Serialization.KnownType("GetKnownTypes")]
[System.Serializable]
public class FaultException<TDetail> : System.ServiceModel.FaultException[System.Serializable]
public class FaultException<TDetail> : System.ServiceModel.FaultExceptiontype FaultException<'Detail> = class
inherit FaultException[<System.Runtime.Serialization.KnownType("GetKnownTypes")>]
[<System.Serializable>]
type FaultException<'Detail> = class
inherit FaultException[<System.Serializable>]
type FaultException<'Detail> = class
inherit FaultExceptionPublic Class FaultException(Of TDetail)
Inherits FaultException型パラメーター
- TDetail
シリアル化可能なエラーの詳細な型。
- 継承
- 継承
- 派生
- 属性
例
次のコード例では、FaultException<TDetail> により指定された SOAP エラーに変換されるマネージド例外をスローするために、サービスが 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) を使用してクライアントによってインポートされた場合のクライアント コードの外観を示しています。
次のコード例は、操作コントラクト内に指定されたカスタム SOAP エラーを表す FaultException<TDetail> 型をクライアントがキャッチできる方法を示しています。
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 エラーを処理します。
通常使用されるサービスでは、FaultContractAttribute を使用して、通常の操作中に受信することをクライアントが予期できるすべての SOAP エラーを正式に指定します。 のエラー情報は、クライアント アプリケーションに FaultContractAttribute 到着すると、 として表示されます FaultException<TDetail> (typeparameter は、操作 FaultContractAttributeで指定されたシリアル化可能なエラー オブジェクトです)。 FaultContractAttribute を使用して、双方向サービス メソッドと非同期メソッド ペアの SOAP エラーを両方とも指定できます。
FaultException<TDetail> は FaultException であり、したがって CommunicationException でもあるので、指定された SOAP エラーをキャッチするには、FaultException<TDetail> 型と FaultException 型をキャッチする前に CommunicationException 型を必ずキャッチするか、指定された例外を例外ハンドラーのいずれかで必ず処理します。
注意
System.ServiceModel.FaultContractAttribute を使用して、型パラメーターが FaultException<TDetail> である System.String を指定した場合、クライアント アプリケーションでは文字列値に Detail プロパティが割り当てられ、クライアントは FaultException<TDetail>.ToString メソッドを呼び出してもその文字列を取得できません。 クライアント アプリケーションが Exception.ToString を呼び出したときにこの文字列値を返すには、操作内で System.ServiceModel.FaultException 例外をスローし、この文字列をコンストラクターに渡します。 通常は、詳細な型はエラーに適したシリアル化可能なカスタム型にし、System.String にはしないことをお勧めします。
コンストラクター
プロパティ
| Action |
エラー メッセージの SOAP アクションの値を取得します。 (継承元 FaultException) |
| Code |
SOAP エラーのエラー コードを取得します。 (継承元 FaultException) |
| Data |
例外に関する追加のユーザー定義情報を提供する、キーと値のペアのコレクションを取得します。 (継承元 Exception) |
| Detail |
エラー状態の詳細情報を格納するオブジェクトを取得します。 |
| HelpLink |
この例外に関連付けられているヘルプ ファイルへのリンクを取得または設定します。 (継承元 Exception) |
| HResult |
特定の例外に割り当てられているコード化数値である HRESULT を取得または設定します。 (継承元 Exception) |
| InnerException |
現在の例外の原因となる Exception インスタンスを取得します。 (継承元 Exception) |
| Message |
例外メッセージを取得します。 (継承元 FaultException) |
| Reason |
SOAP エラーの FaultReason を取得します。 (継承元 FaultException) |
| Source |
エラーの原因となるアプリケーションまたはオブジェクトの名前を取得または設定します。 (継承元 Exception) |
| StackTrace |
呼び出し履歴で直前のフレームの文字列形式を取得します。 (継承元 Exception) |
| TargetSite |
現在の例外がスローされたメソッドを取得します。 (継承元 Exception) |
メソッド
| CreateMessageFault() |
SOAP エラーを表す MessageFault を作成するために使用できる Message オブジェクトを作成します。 |
| Equals(Object) |
指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object) |
| GetBaseException() |
派生クラスでオーバーライドされた場合、それ以後に発生する 1 つ以上の例外の根本原因である Exception を返します。 (継承元 Exception) |
| GetHashCode() |
既定のハッシュ関数として機能します。 (継承元 Object) |
| GetObjectData(SerializationInfo, StreamingContext) |
古い.
オブジェクトがストリームにシリアル化されるときに呼び出される GetObjectData(SerializationInfo, StreamingContext) メソッドの実装です。 |
| GetObjectData(SerializationInfo, StreamingContext) |
古い.
オブジェクトがストリームにシリアル化されるときに呼び出される GetObjectData(SerializationInfo, StreamingContext) メソッドの実装です。 (継承元 FaultException) |
| GetType() |
現在のインスタンスのランタイム型を取得します。 (継承元 Exception) |
| MemberwiseClone() |
現在の Object の簡易コピーを作成します。 (継承元 Object) |
| ToString() |
FaultException<TDetail> オブジェクトの文字列を返します。 |
イベント
| SerializeObjectState |
古い.
例外がシリアル化され、例外に関するシリアル化されたデータを含む例外状態オブジェクトが作成されたときに発生します。 (継承元 Exception) |
適用対象
.NET