MessageHeader Class
TOC
Collapse the table of content
Expand the table of content

MessageHeader Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Represents the content of a SOAP header.

System.Object
  System.ServiceModel.Channels.MessageHeaderInfo
    System.ServiceModel.Channels.MessageHeader

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

public abstract class MessageHeader : MessageHeaderInfo

The MessageHeader type exposes the following members.

  NameDescription
Protected methodMessageHeaderInitializes a new instance of the MessageHeader class.
Top

  NameDescription
Public propertyActorGets or sets the targeted recipient of the message header. (Overrides MessageHeaderInfo.Actor.)
Public propertyIsReferenceParameterGets a value that specifies whether this message header contains reference parameters of an endpoint reference. (Overrides MessageHeaderInfo.IsReferenceParameter.)
Public propertyMustUnderstandGets or sets a value that indicates whether the header must be understood, according to SOAP 1.1 or 1.2 specification. (Overrides MessageHeaderInfo.MustUnderstand.)
Public propertyNameGets the name of the message header. (Inherited from MessageHeaderInfo.)
Public propertyNamespaceGets the namespace of the message header. (Inherited from MessageHeaderInfo.)
Public propertyRelayGets a value that indicates whether the header should be relayed. (Overrides MessageHeaderInfo.Relay.)
Top

  NameDescription
Public methodStatic memberCreateHeader(String, String, Object)Creates a new message header with the specified data.
Public methodStatic memberCreateHeader(String, String, Object, Boolean)Creates a new message header with the specified data.
Public methodStatic memberCreateHeader(String, String, Object, XmlObjectSerializer)Creates a header from an object to be serialized using the XmlFormatter.
Public methodStatic memberCreateHeader(String, String, Object, Boolean, String)Creates a new message header with the specified data.
Public methodStatic memberCreateHeader(String, String, Object, XmlObjectSerializer, Boolean)Creates a new message header with the specified data.
Public methodStatic memberCreateHeader(String, String, Object, Boolean, String, Boolean)Creates a new message header with the specified data.
Public methodStatic memberCreateHeader(String, String, Object, XmlObjectSerializer, Boolean, String)Creates a new message header with the specified data.
Public methodStatic memberCreateHeader(String, String, Object, XmlObjectSerializer, Boolean, String, Boolean)Creates a new message header with the specified data.
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 the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsMessageVersionSupportedVerifies whether the specified message version is supported.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnWriteHeaderContentsCalled when the header content is serialized using the specified XML writer.
Protected methodOnWriteStartHeaderCalled when the start header is serialized using the specified XML writer.
Public methodToStringConverts this message header to a string. (Overrides Object.ToString().)
Public methodWriteHeader(XmlDictionaryWriter, MessageVersion)Serializes the header using the specified XML writer.
Public methodWriteHeader(XmlWriter, MessageVersion)Serializes the header using the specified XML writer.
Protected methodWriteHeaderAttributesSerializes the header contents using the specified XML writer.
Public methodWriteHeaderContentsSerializes the header contents using the specified XML writer.
Public methodWriteStartHeaderSerializes the start header using the specified XML writer.
Top

A message header contains optional metadata that describe a message encapsulated by the Message class.

A Message can have zero or more headers that are used as an extension mechanism to pass information in messages that are application specific. You can use Headers to add message headers to a message by calling the Add method.

Windows Phone provides a number of predefined message headers, as shown in the following table.

Header Name

Description

To

Contains the role that the message is targeting.

Action

Provides a description of how the message should be processed.

FaultTo

Contains the address of the node to which faults should be sent.

From

Contains the address of the node that sent the message.

Request

Indicates whether the message is a request.

MessageID

Contains the unique ID of the message.

RelatesTo

Contains the IDs of messages that are related to this message.

ReplyTo

Contains the address of the node to which a reply should be sent for a request.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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:
© 2017 Microsoft