FaultException Clase

Referencia

Definición

Espacio de nombres:: System.ServiceModel

Ensamblado:: System.ServiceModel.Primitives.dll

Ensamblado:: System.ServiceModel.dll

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Representa un error de SOAP.

public ref class FaultException : System::ServiceModel::CommunicationException

public class FaultException : System.ServiceModel.CommunicationException

[System.Serializable]
public class FaultException : System.ServiceModel.CommunicationException

[System.Serializable]
[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))]
public class FaultException : System.ServiceModel.CommunicationException

type FaultException = class
    inherit CommunicationException

[<System.Serializable>]
type FaultException = class
    inherit CommunicationException

[<System.Serializable>]
[<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))>]
type FaultException = class
    inherit CommunicationException

Public Class FaultException
Inherits CommunicationException

Herencia: Object

Exception

CommunicationException
FaultException

Herencia: Object

Exception

SystemException

CommunicationException
FaultException

Derivado: System.ServiceModel.FaultException<TDetail>

System.ServiceModel.Web.WebFaultException

Atributos: SerializableAttribute KnownTypeAttribute

Ejemplos

El ejemplo de código siguiente muestra el uso de un bloque try/catch para detectar y administrar los objetos FaultException iniciados desde un servicio. Esto ocurre a menudo cuando se activa la depuración en la aplicación de servicio.

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

Comentarios

En un servicio, utilice la clase FaultException para crear un error sin tipo que devolver al cliente para fines de depuración.

En un cliente, detecte objetos FaultException para administrar errores desconocidos o genéricos, como aquéllos devueltos por un servicio con la propiedad IncludeExceptionDetailInFaults definida en true. Dado que FaultException extiende CommunicationException, recuerde detectar cualquier objeto FaultException antes de detectar objetos CommunicationException si desea hacerlo por separado.

Nota

Los servicios dúplex también pueden detectar objetos FaultException devueltos de su interacción con un cliente dúplex.

En general, se recomienda encarecidamente que utilice FaultContractAttribute para diseñar los servicios para devolver los errores de SOAP fuertemente tipados (y no los objetos de excepción administrados) para todos los casos de error en los que decida que el cliente necesita información sobre el error. Sin embargo, utilice FaultException en las siguientes situaciones:

Para enviar los errores de SOAP desde un servicio para fines de depuración.
Para detectar los errores de SOAP en un cliente cuando los errores no forman parte del contrato de servicio.

Inicie los objetos FaultException cuando desee pasar la cadena al constructor y que el cliente la recupere llamando al método FaultException<TDetail>.ToString. Si especifica un contrato de error de tipo System.ServiceModel.FaultException<TDetail> donde el parámetro de tipo es System.String, el valor de la cadena estará disponible como propiedad FaultException<TDetail>.Detail y no llamando a FaultException<TDetail>.ToString.

Para obtener más información, consulte Especificación y control de errores en contratos y servicios.

Constructores

FaultException()	Inicializa una nueva instancia de la clase FaultException.
FaultException(FaultReason)	Inicializa una instancia nueva de la clase FaultException con la razón especificada.
FaultException(FaultReason, FaultCode)	Inicializa una instancia nueva de la clase FaultException con la razón y el código de error especificados.
FaultException(FaultReason, FaultCode, String)	Inicializa una instancia nueva de la clase FaultException con la razón, código de error y valor de acción especificados.
FaultException(MessageFault)	Inicializa una instancia nueva de la clase FaultException con los valores de error del mensaje especificado.
FaultException(MessageFault, String)	Inicializa una instancia nueva de la clase FaultException con los valores de error del mensaje especificados y la cadena de acciones proporcionada.
FaultException(SerializationInfo, StreamingContext)	Inicializa una nueva instancia de la clase FaultException con los parámetros especificados: la información de serialización y el contexto al deserializar una secuencia en un objeto FaultException.
FaultException(String)	Inicializa una instancia nueva de la clase FaultException con el razón del error especificada.
FaultException(String, FaultCode)	Inicializa una instancia nueva de la clase FaultException con la razón especificada y el código de error de SOAP.
FaultException(String, FaultCode, String)	Inicializa una instancia nueva de la clase FaultException con la razón, código de error y valor de acción especificados.

Propiedades

Action	Obtiene el valor de la acción de SOAP para el mensaje de error.
Code	Obtiene el código de error para el error de SOAP.
Data	Obtiene una colección de pares clave/valor que proporciona información definida por el usuario adicional sobre la excepción. (Heredado de Exception)
HelpLink	Obtiene o establece un vínculo al archivo de ayuda asociado a esta excepción. (Heredado de Exception)
HResult	Obtiene o establece HRESULT, un valor numérico codificado que se asigna a una excepción específica. (Heredado de Exception)
InnerException	Obtiene la instancia Exception que produjo la excepción actual. (Heredado de Exception)
Message	Obtiene el mensaje para la excepción.
Reason	Obtiene FaultReason para el error de SOAP.
Source	Devuelve o establece el nombre de la aplicación o del objeto que generó el error. (Heredado de Exception)
StackTrace	Obtiene una representación de cadena de los marcos inmediatos en la pila de llamadas. (Heredado de Exception)
TargetSite	Obtiene el método que produjo la excepción actual. (Heredado de Exception)

Métodos

CreateFault(MessageFault, String, Type[])	Devuelve un objeto FaultException desde el error del mensaje, la acción y una matriz de tipos de detalle especificados.
CreateFault(MessageFault, Type[])	Devuelve un objeto FaultException desde el error del mensaje especificado y una matriz de tipos de detalle.
CreateMessageFault()	Devuelve un objeto MessageFault.
Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetBaseException()	Cuando se invalida en una clase derivada, devuelve la clase Exception que representa la causa principal de una o más excepciones posteriores. (Heredado de Exception)
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetObjectData(SerializationInfo, StreamingContext)	Implementación del método GetObjectData(SerializationInfo, StreamingContext) al que se llama cuando el objeto se serializa en un flujo.
GetObjectData(SerializationInfo, StreamingContext)	Cuando se invalida en una clase derivada, establece SerializationInfo con información sobre la excepción. (Heredado de Exception)
GetType()	Obtiene el tipo de tiempo de ejecución de la instancia actual. (Heredado de Exception)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
ToString()	Crea y devuelve una representación de cadena de la excepción actual. (Heredado de Exception)

Eventos

SerializeObjectState

Obsoleto.

Ocurre cuando una excepción se serializa para crear un objeto de estado de excepción que contenga datos serializados sobre la excepción.

(Heredado de Exception)

Se aplica a