SoapHeaderException Class

 

The SOAP representation of a server error.

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

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

[SerializableAttribute]
public class SoapHeaderException : SoapException

NameDescription
System_CAPS_pubmethodSoapHeaderException()

Initializes a new instance of the SoapHeaderException class.

System_CAPS_protmethodSoapHeaderException(SerializationInfo, StreamingContext)

Initializes a new instance of the SoapHeaderException class with parameters for controlling serialization.

System_CAPS_pubmethodSoapHeaderException(String, XmlQualifiedName)

Initializes a new instance of the SoapHeaderException class.

System_CAPS_pubmethodSoapHeaderException(String, XmlQualifiedName, Exception)

Initializes a new instance of the SoapHeaderException class.

System_CAPS_pubmethodSoapHeaderException(String, XmlQualifiedName, String)

Initializes a new instance of the SoapHeaderException class.

System_CAPS_pubmethodSoapHeaderException(String, XmlQualifiedName, String, Exception)

Initializes a new instance of the SoapHeaderException class.

System_CAPS_pubmethodSoapHeaderException(String, XmlQualifiedName, String, String, SoapFaultSubCode, Exception)

Initializes a new instance of the SoapHeaderException class with the associated data.

System_CAPS_pubmethodSoapHeaderException(String, XmlQualifiedName, String, String, String, SoapFaultSubCode, Exception)

Initializes a new instance of the SoapHeaderException class with the associated data.

NameDescription
System_CAPS_pubpropertyActor

Gets the piece of code that caused the exception.(Inherited from SoapException.)

System_CAPS_pubpropertyCode

Gets the type of SOAP fault code.(Inherited from SoapException.)

System_CAPS_pubpropertyData

Gets a collection of key/value pairs that provide additional user-defined information about the exception.(Inherited from Exception.)

System_CAPS_pubpropertyDetail

Gets an XmlNode that represents the application-specific error information details.(Inherited from SoapException.)

System_CAPS_pubpropertyHelpLink

Gets or sets a link to the help file associated with this exception.(Inherited from Exception.)

System_CAPS_pubpropertyHResult

Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.(Inherited from Exception.)

System_CAPS_pubpropertyInnerException

Gets the Exception instance that caused the current exception.(Inherited from Exception.)

System_CAPS_pubpropertyLang

Gets the human language associated with the exception.(Inherited from SoapException.)

System_CAPS_pubpropertyMessage

Gets a message that describes the current exception.(Inherited from Exception.)

System_CAPS_pubpropertyNode

Gets a URI that represents the piece of code that caused the exception.(Inherited from SoapException.)

System_CAPS_pubpropertyRole

Gets a URI that represents the XML Web service's function in processing the SOAP message.(Inherited from SoapException.)

System_CAPS_pubpropertySource

Gets or sets the name of the application or the object that causes the error.(Inherited from Exception.)

System_CAPS_pubpropertyStackTrace

Gets a string representation of the immediate frames on the call stack.(Inherited from Exception.)

System_CAPS_pubpropertySubCode

Gets the optional error information contained in the subcode XML element of a SOAP fault.(Inherited from SoapException.)

System_CAPS_pubpropertyTargetSite

Gets the method that throws the current exception.(Inherited from Exception.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetBaseException()

When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.(Inherited from Exception.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetObjectData(SerializationInfo, StreamingContext)

Sets the T:System.Runtime.Serialization.SerializationInfo with information about the exception.(Inherited from SoapException.)

System_CAPS_pubmethodGetType()

Gets the runtime type of the current instance.(Inherited from Exception.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Creates and returns a string representation of the current exception.(Inherited from Exception.)

NameDescription
System_CAPS_proteventSerializeObjectState

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.

System_CAPS_noteNote

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.

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.

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());
        }
    }
}

.NET Framework
Available since 1.1

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

Return to top
Show: