FaultException<TDetail> FaultException<TDetail> FaultException<TDetail> FaultException<TDetail> Class

Définition

Utilisé dans une application cliente pour intercepter les erreurs SOAP spécifiées contractuellement.Used in a client application to catch contractually-specified SOAP faults.

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

Paramètres de type

TDetail

Type de détail de l'erreur sérialisable.The serializable error detail type.

Héritage
Dérivé
Attributs

Exemples

L'exemple de code suivant montre comment un service utilise le type d'FaultException<TDetail> pour lever une exception gérée qui est convertie en erreur SOAP spécifiée par l'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
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

L’exemple de code suivant montre comment le code client se présente importé par le client à l’aide de la ServiceModel Metadata Utility Tool (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).

L'exemple de code suivant indique comment un client peut intercepter le type FaultException<TDetail> qui représente l'erreur SOAP personnalisée spécifiée dans le contrat d'opération.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
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

Remarques

Intercepter le FaultException<TDetail> objet dans une application de client Windows Communication Foundation (WCF) pour gérer une erreur SOAP spécifiée contractuellement dans un contrat d’opération.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.

Les services déployés classiques utilisent le FaultContractAttribute pour spécifier de manière formelle toutes les erreurs SOAP qu'un client peut s'attendre à recevoir dans le cours normal d'une opération.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. Informations d’erreur dans un FaultContractAttribute apparaît comme un FaultException<TDetail> (où le typeparameter est l’objet d’erreur sérialisable spécifié dans l’opération FaultContractAttribute) lorsqu’elles arrivent à une application cliente.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. L'FaultContractAttribute peut être utilisé pour spécifier les erreurs SOAP à la fois pour les méthodes de service bidirectionnelles et les paires de méthodes asynchrones.The FaultContractAttribute can be used to specify SOAP faults for both two-way service methods and for asynchronous method pairs.

Étant donné que FaultException<TDetail> est une FaultException et donc également une CommunicationException, assurez-vous que vous interceptez les types FaultException<TDetail> avant les types FaultException et CommunicationException pour intercepter les erreurs SOAP spécifiées ou gérez les exceptions spécifiées dans l'un de ces gestionnaires d'exceptions.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.

Notes

Si vous utilisez un System.ServiceModel.FaultContractAttribute pour spécifier une FaultException<TDetail> où le paramètre de type est une System.String, la valeur de chaîne est assignée à la propriété Detail dans l'application cliente ; les clients ne peuvent pas récupérer cette chaîne en appelant la méthode 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. Pour que la valeur de chaîne soit retournée lorsque l'application cliente appelle Exception.ToString, levez une exception System.ServiceModel.FaultException dans l'opération et passez la chaîne au constructeur.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.
En général, il est recommandé que les types de détail soient des types sérialisables personnalisés appropriés à l'erreur et pas System.String.In general, it is recommended that detail types be custom serializable types appropriate to the fault and not a System.String.

Constructeurs

FaultException<TDetail>(SerializationInfo, StreamingContext) FaultException<TDetail>(SerializationInfo, StreamingContext) FaultException<TDetail>(SerializationInfo, StreamingContext) FaultException<TDetail>(SerializationInfo, StreamingContext)

Initialise une nouvelle instance de la classe FaultException<TDetail> à l'aide des informations de sérialisation spécifiées et du contexte lors de la désérialisation d'un flux en objet 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>(TDetail) FaultException<TDetail>(TDetail) FaultException<TDetail>(TDetail)

Initialise une nouvelle instance de la classe FaultException<TDetail> qui utilise l'objet de détail spécifié.Initializes a new instance of the FaultException<TDetail> class that uses the specified detail object.

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

Initialise une nouvelle instance de la classe FaultException<TDetail> qui utilise l'objet de détail et la raison de l'erreur spécifiés.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>(TDetail, FaultReason, FaultCode) FaultException<TDetail>(TDetail, FaultReason, FaultCode) FaultException<TDetail>(TDetail, FaultReason, FaultCode)

Initialise une nouvelle instance de la classe FaultException<TDetail> qui utilise l'objet de détail, la raison de l'erreur et le code d'erreur spécifiés.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) FaultException<TDetail>(TDetail, FaultReason, FaultCode, String) FaultException<TDetail>(TDetail, FaultReason, FaultCode, String) FaultException<TDetail>(TDetail, FaultReason, FaultCode, String)

Initialise une nouvelle instance de la classe FaultException<TDetail> qui utilise l'objet de détail spécifié et les valeurs de la raison de l'erreur SOAP, du code et de l'action.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>(TDetail, String) FaultException<TDetail>(TDetail, String) FaultException<TDetail>(TDetail, String)

Initialise une nouvelle instance de la classe FaultException<TDetail> qui utilise le détail et la raison de l'erreur spécifiés.Initializes a new instance of the FaultException<TDetail> class that uses the specified detail and fault reason.

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

Initialise une nouvelle instance de la classe FaultException<TDetail> qui utilise l'objet de détail, la raison de l'erreur et le code d'erreur spécifiés.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) FaultException<TDetail>(TDetail, String, FaultCode, String) FaultException<TDetail>(TDetail, String, FaultCode, String) FaultException<TDetail>(TDetail, String, FaultCode, String)

Initialise une nouvelle instance de la classe FaultException<TDetail> qui utilise l'objet de détail spécifié et les valeurs de la raison de l'erreur SOAP, du code et de l'action.Initializes a new instance of the FaultException<TDetail> class that uses the specified detail object, and SOAP fault reason, code and action values.

Propriétés

Action Action Action Action

Obtient la valeur de l'action SOAP pour le message d'erreur.Gets the value of the SOAP action for the fault message.

(Inherited from FaultException)
Code Code Code Code

Obtient le code d'erreur pour l'erreur SOAP.Gets the fault code for the SOAP fault.

(Inherited from FaultException)
Data Data Data Data

Obtient une collection de paires clé/valeur qui fournissent des informations supplémentaires définies par l’utilisateur sur l’exception.Gets a collection of key/value pairs that provide additional user-defined information about the exception.

(Inherited from Exception)
Detail Detail Detail Detail

Obtient l'objet qui contient les informations de détail de la condition de l'erreur.Gets the object that contains the detail information of the fault condition.

HelpLink HelpLink HelpLink HelpLink

Obtient ou définit un lien vers le fichier d'aide associé à cette exception.Gets or sets a link to the help file associated with this exception.

(Inherited from Exception)
HResult HResult HResult HResult

Obtient ou définit HRESULT, valeur numérique codée qui est assignée à une exception spécifique.Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.

(Inherited from Exception)
InnerException InnerException InnerException InnerException

Obtient l'instance Exception qui a provoqué l'exception actuelle.Gets the Exception instance that caused the current exception.

(Inherited from Exception)
Message Message Message Message

Obtient le message pour l'exception.Gets the message for the exception.

(Inherited from FaultException)
Reason Reason Reason Reason

Obtient la FaultReason de l'erreur SOAP.Gets the FaultReason for the SOAP fault.

(Inherited from FaultException)
Source Source Source Source

Obtient ou définit le nom de l'application ou de l'objet qui est à l'origine de l'erreur.Gets or sets the name of the application or the object that causes the error.

(Inherited from Exception)
StackTrace StackTrace StackTrace StackTrace

Obtient une représentation sous forme de chaîne des frames immédiats sur la pile des appels.Gets a string representation of the immediate frames on the call stack.

(Inherited from Exception)
TargetSite TargetSite TargetSite TargetSite

Obtient la méthode qui lève l'exception actuelle.Gets the method that throws the current exception.

(Inherited from Exception)

Méthodes

CreateMessageFault() CreateMessageFault() CreateMessageFault() CreateMessageFault()

Crée un objet MessageFault qui peut être utilisé pour créer un Message qui représente l'erreur SOAP.Creates a MessageFault object that can be used to create a Message that represents the SOAP fault.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Détermine si l'objet spécifié est identique à l'objet actuel.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetBaseException() GetBaseException() GetBaseException() GetBaseException()

En cas de substitution dans une classe dérivée, retourne la Exception qui est à l'origine d'une ou de plusieurs exceptions ultérieures.When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.

(Inherited from Exception)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Fait office de fonction de hachage par défaut.Serves as the default hash function.

(Inherited from Object)
GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext)

Implémentation de la méthode GetObjectData(SerializationInfo, StreamingContext) appelée lorsque l'objet est dans un flux.Implementation of the GetObjectData(SerializationInfo, StreamingContext) method that is called when the object is serialized into a stream.

GetType() GetType() GetType() GetType()

Obtient le type au moment de l'exécution de l'instance actuelle.Gets the runtime type of the current instance.

(Inherited from Exception)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crée une copie superficielle de l'objet Object actuel.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Retourne une chaîne pour l'objet FaultException<TDetail>.Returns a string for the FaultException<TDetail> object.

Événements

SerializeObjectState SerializeObjectState SerializeObjectState SerializeObjectState

Se produit quand une exception est sérialisée pour créer un objet d'état d'exception qui contient des données sérialisées concernant l'exception.Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.

(Inherited from Exception)

S’applique à