MessageHeaderAttribute Klasse

Definition

public ref class MessageHeaderAttribute : System::ServiceModel::MessageContractMemberAttribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=false)]
public class MessageHeaderAttribute : System.ServiceModel.MessageContractMemberAttribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, Inherited=false)]
public class MessageHeaderAttribute : System.ServiceModel.MessageContractMemberAttribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=false)>]
type MessageHeaderAttribute = class
    inherit MessageContractMemberAttribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, Inherited=false)>]
type MessageHeaderAttribute = class
    inherit MessageContractMemberAttribute

Public Class MessageHeaderAttribute
Inherits MessageContractMemberAttribute

Vererbung

Object

Attribute

MessageContractMemberAttribute

MessageHeaderAttribute

Abgeleitet

System.ServiceModel.MessageHeaderArrayAttribute

System.ServiceModel.PeerHopCountAttribute

Attribute

AttributeUsageAttribute

Beispiele

Anhand des folgenden Codebeispiels wird veranschaulicht, wie MessageHeaderAttribute zum Erstellen eines SOAP-Headers für die Antwortnachricht mit den Eigenschaften Name, Namespace und MustUnderstand verwendet wird, für die für diesen Header geeignete Werte festgelegt wurden. Dem Codebeispiel folgt ein Beispiel der gesendeten Nachricht.

 [MessageContract]
 public class HelloResponseMessage
 {
   private string localResponse = String.Empty;
   private string extra = String.Empty;

   [MessageBodyMember(
     Name = "ResponseToGreeting",
     Namespace = "http://www.examples.com")]
   public string Response
   {
     get { return localResponse; }
     set { localResponse = value; }
   }

   [MessageHeader(
     Name = "OutOfBandData",
     Namespace = "http://www.examples.com",
     MustUnderstand=true
   )]
   public string ExtraValues
   {
     get { return extra; }
     set { this.extra = value; }
  }

  /*
   The following is the response message, edited for clarity.

   <s:Envelope>
     <s:Header>
       <a:Action s:mustUnderstand="1">http://HelloResponseMessage/Action</a:Action>
       <h:OutOfBandData s:mustUnderstand="1" xmlns:h="http://www.examples.com">Served by object 13804354.</h:OutOfBandData>
     </s:Header>
     <s:Body>
       <HelloResponseMessage xmlns="Microsoft.WCF.Documentation">
         <ResponseToGreeting xmlns="http://www.examples.com">Service received: Hello.</ResponseToGreeting>
       </HelloResponseMessage>
     </s:Body>
   </s:Envelope>
   */
}

  <MessageContract> _
  Public Class HelloResponseMessage
    Private localResponse As String = String.Empty
    Private extra As String = String.Empty

    <MessageBodyMember(Name := "ResponseToGreeting", Namespace := "http://www.examples.com")> _
    Public Property Response() As String
      Get
          Return localResponse
      End Get
      Set(ByVal value As String)
          localResponse = value
      End Set
    End Property

    <MessageHeader(Name := "OutOfBandData", Namespace := "http://www.examples.com", MustUnderstand:=True)> _
    Public Property ExtraValues() As String
      Get
          Return extra
      End Get
      Set(ByVal value As String)
          Me.extra = value
      End Set
    End Property

'   
'    The following is the response message, edited for clarity.
'    
'    <s:Envelope>
'      <s:Header>
'        <a:Action s:mustUnderstand="1">http://HelloResponseMessage/Action</a:Action>
'        <h:OutOfBandData s:mustUnderstand="1" xmlns:h="http://www.examples.com">Served by object 13804354.</h:OutOfBandData>
'      </s:Header>
'      <s:Body>
'        <HelloResponseMessage xmlns="Microsoft.WCF.Documentation">
'          <ResponseToGreeting xmlns="http://www.examples.com">Service received: Hello.</ResponseToGreeting>
'      </s:Body>    
'    </s:Envelope>
'    
  End Class

Hinweise

Das MessageHeaderAttribute-Attribut ermöglicht es, die Felder und Eigenschaften eines Typs, der mit dem MessageContractAttribute-Attribut gekennzeichnet ist, den SOAP-Nachrichtenheadern zuzuordnen. Das Feld oder die Eigenschaft kann ein einfacher oder zusammengesetzter Typ sein, der serialisiert werden kann.

Informationen zum Steuern der Serialisierung des Inhalts eines SOAP-Texts, ohne den Standard-SOAP-Umschlag selbst zu ändern, finden Sie unter System.Runtime.Serialization.DataContractAttribute, Angeben der Datenübertragung in Dienstverträgen und Verwenden von Datenverträgen.

Weitere Informationen zum Erstellen von Nachrichtenverträgen finden Sie unter Verwenden von Nachrichtenverträgen.

Der SOAP-Standard definiert die folgenden Attribute, die in einem Header verwendet werden können:

• Actor oder Role (Actor in SOAP 1.1; Role in SOAP 1.2)

• MustUnderstand

• Relay

Das Actor-Attribut oder das Role-Attribut legt den URI des Knoten fest, für den ein bestimmter Header angegeben wurde. Das MustUnderstand-Attribut gibt an, ob der Header die Knotenverarbeitung versteht. Das Relay-Attribut gibt an, ob der Header an Downstreamknoten weitergeleitet werden soll. Windows Communication Foundation (WCF) führt keine Verarbeitung dieser Attribute für eingehende Nachrichten aus, mit Ausnahme des MustUnderstand Attributs.

Sie können jedoch diese Attribute lesen und schreiben, selbst wenn sie nicht standardmäßig gesendet werden. Sie können die Attributwerte auf zwei Weisen festlegen. Sie können zunächst die Eigenschaften Actor, MustUnderstand und Relay in MessageHeaderAttribute ändern. (Es gibt keine Role Eigenschaft – Legen Sie die Actor Eigenschaft fest und Role wird übergeben, wenn SOAP 1.2 verwendet wird). Beispiel:

Sie können diese Attribute jedoch auch steuern, indem Sie den gewünschten Headertyp als Typparameter der MessageHeader<T>-Klasse festlegen und den erstellten Typ zusammen mit MessageHeaderAttribute verwenden. Verwenden Sie dann die MessageHeader<T>-Eigenschaften, um die SOAP-Attribute programmgesteuert festzulegen. Beispiel:

Wenn sowohl der dynamische als auch der statische Kontrollmechanismus verwendet werden, sind standardmäßig die statischen Einstellungen ausgewählt, sie können jedoch mit dem dynamischen Mechanismus überschrieben werden. Beispiel:

Das Erstellen von wiederholten Headern mit einem dynamischen Attributsteuerelement ist zulässig. Beispiel:

[MessageHeaderArray] public MessageHeader<Person> documentApprovers[];  

Wenn Sie diese SOAP-Attribute auf Empfängerseite lesen möchten, muss die generische MessageHeader<T>-Klasse verwendet werden. Überprüfen Sie die Eigenschaften Actor, Relay oder MustUnderstand des Headers des MessageHeader<T>-Typs, um die Attributeinstellungen für die empfangene Nachricht anzuzeigen.

Wenn eine Nachricht empfangen und dann zurückgesendet wird, werden die SOAP-Attributeinstellungen nur für Header des MessageHeader<T>-Typs wiederhergestellt.

Konstruktoren

Eigenschaften

Methoden

Explizite Schnittstellenimplementierungen

Gilt für