SoapHeaderException Class

.NET Framework (current version)

The SOAP representation of a server error.

Namespace: System.Web.Services.Protocols
Assembly: System.Web.Services (in System.Web.Services.dll)

Inheritance Hierarchy

System.Object
System.Exception
System.SystemException
System.Web.Services.Protocols.SoapException
System.Web.Services.Protocols.SoapHeaderException

Syntax

C++

[SerializableAttribute]
public class SoapHeaderException : SoapException

Constructors

	Name	Description
	SoapHeaderException()	Initializes a new instance of the SoapHeaderException class.
	SoapHeaderException(SerializationInfo, StreamingContext)	Initializes a new instance of the SoapHeaderException class with parameters for controlling serialization.
	SoapHeaderException(String, XmlQualifiedName)	Initializes a new instance of the SoapHeaderException class.
	SoapHeaderException(String, XmlQualifiedName, Exception)	Initializes a new instance of the SoapHeaderException class.
	SoapHeaderException(String, XmlQualifiedName, String)	Initializes a new instance of the SoapHeaderException class.
	SoapHeaderException(String, XmlQualifiedName, String, Exception)	Initializes a new instance of the SoapHeaderException class.
	SoapHeaderException(String, XmlQualifiedName, String, String, SoapFaultSubCode, Exception)	Initializes a new instance of the SoapHeaderException class with the associated data.
	SoapHeaderException(String, XmlQualifiedName, String, String, String, SoapFaultSubCode, Exception)	Initializes a new instance of the SoapHeaderException class with the associated data.

Properties

	Name	Description
	Actor	Gets the piece of code that caused the exception.(Inherited from SoapException.)
	Code	Gets the type of SOAP fault code.(Inherited from SoapException.)
	Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception.(Inherited from Exception.)
	Detail	Gets an XmlNode that represents the application-specific error information details.(Inherited from SoapException.)
	HelpLink	Gets or sets a link to the help file associated with this exception.(Inherited from Exception.)
	HResult	Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.(Inherited from Exception.)
	InnerException	Gets the Exception instance that caused the current exception.(Inherited from Exception.)
	Lang	Gets the human language associated with the exception.(Inherited from SoapException.)
	Message	Gets a message that describes the current exception.(Inherited from Exception.)
	Node	Gets a URI that represents the piece of code that caused the exception.(Inherited from SoapException.)
	Role	Gets a URI that represents the XML Web service's function in processing the SOAP message.(Inherited from SoapException.)
	Source	Gets or sets the name of the application or the object that causes the error.(Inherited from Exception.)
	StackTrace	Gets a string representation of the immediate frames on the call stack.(Inherited from Exception.)
	SubCode	Gets the optional error information contained in the subcode XML element of a SOAP fault.(Inherited from SoapException.)
	TargetSite	Gets the method that throws the current exception.(Inherited from Exception.)

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetBaseException()	When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.(Inherited from Exception.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetObjectData(SerializationInfo, StreamingContext)	Sets the T:System.Runtime.Serialization.SerializationInfo with information about the exception.(Inherited from SoapException.)
	GetType()	Gets the runtime type of the current instance.(Inherited from Exception.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Creates and returns a string representation of the current exception.(Inherited from Exception.)

Events

	Name	Description
	SerializeObjectState	Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.(Inherited from Exception.)

When an XML Web service client adds a SOAP header to an XML Web service method call with the MustUnderstand property set to true, the XML Web service method must set the DidUnderstand property to true; otherwise, a SoapHeaderException is thrown.

The Detail property cannot be set according to the SOAP specification for a SoapHeaderException.

Note
Applications that use the SOAP 1.1 specification as the service protocol can use the SoapHeaderException to access SOAP faults. However, applications that use the SOAP 1.2 specification must use the SoapException to access SOAP faults.

Examples

In the following example, an XML Web service client calls the MyWebMethod XML Web service method, passing in a SOAP header of type MyHeader with the MustUnderstand property set to true. If the XML Web service method does not set the DidUnderstand property of the MyHeader SOAP header to true, a SoapHeaderException is thrown.

C++

using System;

public class Sample {

    public static void Main() {
        MyWebService ws = new MyWebService();

        try {
            MyHeader customHeader = new MyHeader();
            customHeader.MyValue = "Header Value for MyValue";
            customHeader.MustUnderstand = true;
            ws.myHeader = customHeader;

	    int results = ws.MyWebMethod(3,5);
        }
        catch (Exception e) {
            Console.WriteLine ("Exception: {0}", e.ToString());
        }
    }
}

Version Information

.NET Framework
Available since 1.1

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.