MessageHeaderException Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

The exception that is thrown when the expectations regarding headers of a SOAP message are not satisfied when the message is processed.

Inheritance Hierarchy

System.Object
  System.Exception
    System.SystemException
      System.ServiceModel.CommunicationException
        System.ServiceModel.ProtocolException
          System.ServiceModel.MessageHeaderException

Namespace:  System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

Syntax

'Declaration
Public Class MessageHeaderException _
    Inherits ProtocolException

public class MessageHeaderException : ProtocolException

The MessageHeaderException type exposes the following members.

Constructors

	Name	Description
	MessageHeaderException()	Initializes a new instance of the MessageHeaderException class.
	MessageHeaderException(String)	Initializes a new instance of the MessageHeaderException class with the specified message.
	MessageHeaderException(String, Boolean)	Initializes a new instance of the MessageHeaderException class using the specified message and a value that indicates whether the message header is a duplicate or is missing.
	MessageHeaderException(String, Exception)	Initializes a new instance of the MessageHeaderException class using the specified message and the inner exception that caused the exception.
	MessageHeaderException(String, String, String)	Initializes a new instance of the MessageHeaderException class using the specified message, header name, and namespace.
	MessageHeaderException(String, String, String, Boolean)	Initializes a new instance of the MessageHeaderException class using the specified message, header name, and namespace, and a value that indicates whether the message header is a duplicate or is missing.
	MessageHeaderException(String, String, String, Exception)	Initializes a new instance of the MessageHeaderException class using the specified message, header name, and namespace, and the inner exception that caused the exception.
	MessageHeaderException(String, String, String, Boolean, Exception)	Initializes a new instance of the MessageHeaderException class using the specified message, header name, and namespace, a value that indicates whether the message header is a duplicate or is missing, and the inner exception that caused the exception.

Top

Properties

	Name	Description
	Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
	HeaderName	Gets the name of the SOAP header that caused the exception.
	HeaderNamespace	Gets the namespace of the SOAP header that caused the 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.)
	IsDuplicate	Gets a value that indicates whether there are multiple message headers or no message headers.
	Message	Gets a message that describes the current exception. (Inherited from Exception.)
	StackTrace	Gets a string representation of the frames on the call stack at the time the current exception was thrown. (Inherited from Exception.)

Top

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 the Object 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 a hash function for a particular type. (Inherited from Object.)
	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.)

Top

Remarks

This exception is typically thrown when there are too many headers or headers are missing from the message. This can include infrastructure headers, such as the Action and Reliable Message headers. This exception derives from ProtocolException, which in turn derives from CommunicationException. The CommunicationException class represents a class of recoverable errors that may be thrown during communication between endpoints and that robust Silverlight client applications are expected to handle. To prevent the more generic CommunicationException handler from catching the more specific ProtocolException, catch this exception prior to handling CommunicationException.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

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.

See Also

Reference

System.ServiceModel Namespace