System.Runtime.Serialization.Formatters.SoapFault Class

Summary

Carries error and status information within a SOAP message. This class cannot be inherited.

C# Syntax:

[Serializable] public sealed class SoapFault : ISerializable

System.Runtime.Serialization.Formatters Namespace

System.Runtime.Serialization.Formatters.SoapFault Member List:

Public Constructors

ctor #1	Overloaded: .ctor() Default constructor. This constructor is called by derived class constructors to initialize state in this type. Initializes a new instance of the SoapFault class with default values.
ctor #2	Overloaded: .ctor(string faultCode, string faultString, string faultActor, ServerFault serverFault) Initializes a new instance of the SoapFault class, setting the properties to specified values.

Public Properties

Detail	Read-write Gets or sets additional information needed for the SoapFault.
FaultActor	Read-write Gets or sets the fault actor for the SoapFault.
FaultCode	Read-write Gets or sets the fault code for the SoapFault.
FaultString	Read-write Gets or sets the fault message for the SoapFault.

Public Methods

Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetHashCode (inherited from System.Object)	See base class member description: System.Object.GetHashCode Derived from System.Object, the primary base class for all objects.
GetObjectData	Populates the specified SerializationInfo with the data to serialize the SoapFault object.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
ToString (inherited from System.Object)	See base class member description: System.Object.ToString Derived from System.Object, the primary base class for all objects.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

• System.Object
• System.Runtime.Serialization.Formatters.SoapFault

System.Runtime.Serialization.Formatters.SoapFault Member Details

Summary

Initializes a new instance of the SoapFault class with default values.

Default constructor. This constructor is called by derived class constructors to initialize state in this type.

C# Syntax:

public SoapFault();

Return to top

Summary

Initializes a new instance of the SoapFault class, setting the properties to specified values.

C# Syntax:

public SoapFault(    string faultCode,    string faultString,    string faultActor,    ServerFault serverFault );

faultCode

The fault code for the new instance of SoapFault. The fault code identifies the type of the fault that occurred.

faultString

The fault string for the new instance of SoapFault. The fault string provides a human readable explanation of the fault.

faultActor

The URI of the object that generated the fault.

serverFault

The description of a common language runtime exception thrown on the server that is necessary to rethrow the exception on the client. This information is also present in the SoapFault.Detail property.

Return to top

Summary

Gets or sets additional information needed for the SoapFault.

C# Syntax:

public object Detail {get; set;}

The detail element carries application specific error information related to the Body element of a SOAP message.

Return to top

Summary

Gets or sets the fault actor for the SoapFault.

C# Syntax:

public string FaultActor {get; set;}

The SoapFault.FaultActor property provides information about what caused the fault within the message path.

Return to top

Summary

Gets or sets the fault code for the SoapFault.

C# Syntax:

public string FaultCode {get; set;}

The fault code element provides an algorithmic mechanism for identifying the fault.

Return to top

Summary

Gets or sets the fault message for the SoapFault.

C# Syntax:

public string FaultString {get; set;}

The fault string element provides a human readable explanation of the fault and is not intended for algorithmic processing.

Return to top

Inherited
See base class member description: System.Object.Equals

C# Syntax:

public virtual bool Equals(    object obj );

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.Finalize

C# Syntax:

~SoapFault();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.GetHashCode

C# Syntax:

public virtual int GetHashCode();

For more information on members inherited from System.Object click on the link above.

Return to top

Summary

Populates the specified SerializationInfo with the data to serialize the SoapFault object.

C# Syntax:

public void GetObjectData(    SerializationInfo info,    StreamingContext context );

info

The SerializationInfo to populate with data.

context

The destination (see StreamingContext) for the current serialization.

Implements:

ISerializable.GetObjectData

Return to top

Inherited
See base class member description: System.Object.GetType

C# Syntax:

public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.MemberwiseClone

C# Syntax:

protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.ToString

C# Syntax:

public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top

Top of page