MessageFault Class

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.0

Source:

MessageFault.cs

Represents an in-memory representation of a SOAP fault that can be passed to CreateMessage to create a message that contains a fault.

public ref class MessageFault abstract

public abstract class MessageFault

type MessageFault = class

Public MustInherit Class MessageFault

Inheritance

Object

MessageFault

Examples

The following code example shows the most common use of MessageFault. Both the ProvideFault and HandleError pass in a MessageFault object that can be modified and returned to the system (in the case of ProvideFault) or used to perform some custom fault-related behavior (in the case of HandleError).

In this example, the ProvideFault method converts all Exception objects into a MessageFault object that contains a FaultException<TDetail> object of type GreetingFault and returns that customized MessageFault to WCF.

#region IErrorHandler Members
public bool HandleError(Exception error)
{
  Console.WriteLine("HandleError called.");
  // Returning true indicates you performed your behavior.
  return true;
}

// This is a trivial implementation that converts Exception to FaultException<GreetingFault>.
public void ProvideFault(
  Exception error,
  MessageVersion ver,
  ref Message msg
)
{
  Console.WriteLine("ProvideFault called. Converting Exception to GreetingFault....");
  FaultException<GreetingFault> fe
    = new FaultException<GreetingFault>(new GreetingFault(error.Message));
  MessageFault fault = fe.CreateMessageFault();
  msg = Message.CreateMessage(
    ver,
    fault,
    "http://microsoft.wcf.documentation/ISampleService/SampleMethodGreetingFaultFault"
  );
}
#endregion

#Region "IErrorHandler Members"
Public Function HandleError(ByVal [error] As Exception) As Boolean Implements IErrorHandler.HandleError
  Console.WriteLine("HandleError called.")
  ' Returning true indicates you performed your behavior.
  Return True
End Function

' This is a trivial implementation that converts Exception to FaultException<GreetingFault>.
Public Sub ProvideFault(ByVal [error] As Exception, ByVal ver As MessageVersion, ByRef msg As Message) Implements IErrorHandler.ProvideFault
  Console.WriteLine("ProvideFault called. Converting Exception to GreetingFault....")
  Dim fe As New FaultException(Of GreetingFault)(New GreetingFault([error].Message))
  Dim fault As MessageFault = fe.CreateMessageFault()
  msg = Message.CreateMessage(ver, fault, "http://microsoft.wcf.documentation/ISampleService/SampleMethodGreetingFaultFault")
End Sub
#End Region

Remarks

Use the MessageFault class any time you need an in-memory SOAP fault that can be modified and used to create a SOAP message that contains the fault information.

Typically, the MessageFault class is used when implementing the IErrorHandler interface. In this case, Windows Communication Foundation (WCF) passes the MessageFault object and you use it for your specific needs (for example, you can customize the MessageFault or to log fault information). However, MessageFault can be used anywhere custom SOAP fault message handling is required.

Constructors

MessageFault()

When called in a derived class, initializes a new instance of the MessageFault class.

Properties

Actor	Gets or sets the value of the actor.
Code	Gets the SOAP fault code.
HasDetail	Gets a value that indicates whether the MessageFault has a detail object.
Node	Gets the SOAP node containing information about which SOAP node on a message path cause the fault.
Reason	Gets a textual description of a SOAP fault.

Methods

CreateFault(Message, Int32)	Returns a new MessageFault object that uses the specified Message and the specified maximum buffer size for the message buffer.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetDetail<T>()	Returns the detail object of the message fault.
GetDetail<T>(XmlObjectSerializer)	Returns the detail object that uses the specified XmlObjectSerializer.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetReaderAtDetailContents()	Returns an XmlDictionaryReader object that is positioned on the detail object of the MessageFault.
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnGetReaderAtDetailContents()	When called in a derived class, returns an XmlDictionaryReader object that is positioned on the detail object of the MessageFault.
OnWriteDetail(XmlDictionaryWriter, EnvelopeVersion)	Invoked prior to writing the detail contents.
OnWriteDetailContents(XmlDictionaryWriter)	When overridden in a non-abstract derived class, writes the contents of the detail element.
OnWriteStartDetail(XmlDictionaryWriter, EnvelopeVersion)	Writes the start element using the specified XmlDictionaryWriter and SOAP envelope version.
ToString()	Returns a string that represents the current object. (Inherited from Object)