Export (0) Print
Expand All

SoapHeaderException Class

The SOAP representation of a server error.

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

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

[SerializableAttribute]
public class SoapHeaderException : SoapException

The SoapHeaderException type exposes the following members.

  NameDescription
Public methodSoapHeaderException()Initializes a new instance of the SoapHeaderException class.
Protected methodSoapHeaderException(SerializationInfo, StreamingContext)Initializes a new instance of the SoapHeaderException class with parameters for controlling serialization.
Public methodSoapHeaderException(String, XmlQualifiedName)Initializes a new instance of the SoapHeaderException class.
Public methodSoapHeaderException(String, XmlQualifiedName, Exception)Initializes a new instance of the SoapHeaderException class.
Public methodSoapHeaderException(String, XmlQualifiedName, String)Initializes a new instance of the SoapHeaderException class.
Public methodSoapHeaderException(String, XmlQualifiedName, String, Exception)Initializes a new instance of the SoapHeaderException class.
Public methodSoapHeaderException(String, XmlQualifiedName, String, String, SoapFaultSubCode, Exception)Initializes a new instance of the SoapHeaderException class with the associated data.
Public methodSoapHeaderException(String, XmlQualifiedName, String, String, String, SoapFaultSubCode, Exception)Initializes a new instance of the SoapHeaderException class with the associated data.
Top

  NameDescription
Public propertyActorGets the piece of code that caused the exception. (Inherited from SoapException.)
Public propertyCodeGets the type of SOAP fault code. (Inherited from SoapException.)
Public propertyDataGets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public propertyDetailGets an XmlNode that represents the application-specific error information details. (Inherited from SoapException.)
Public propertyHelpLinkGets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Public propertyHResultGets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public propertyInnerExceptionGets the Exception instance that caused the current exception. (Inherited from Exception.)
Public propertyLangGets the human language associated with the exception. (Inherited from SoapException.)
Public propertyMessageGets a message that describes the current exception. (Inherited from Exception.)
Public propertyNodeGets a URI that represents the piece of code that caused the exception. (Inherited from SoapException.)
Public propertyRoleGets a URI that represents the XML Web service's function in processing the SOAP message. (Inherited from SoapException.)
Public propertySourceGets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public propertyStackTraceGets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public propertySubCodeGets the optional error information contained in the subcode XML element of a SOAP fault. (Inherited from SoapException.)
Public propertyTargetSiteGets the method that throws the current exception. (Inherited from Exception.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetBaseExceptionWhen overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetObjectDataSets the [T:System.Runtime.Serialization.][SerializationInfo] with information about the exception. (Inherited from SoapException.)
Public methodGetTypeGets the runtime type of the current instance. (Inherited from Exception.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringCreates and returns a string representation of the current exception. (Inherited from Exception.)
Top

  NameDescription
Protected eventSerializeObjectStateOccurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.)
Top

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.

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

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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