MessageHeaderAttribute.MustUnderstand Eigenschaft

Definition

Namespace:

System.ServiceModel

Assembly:

System.ServiceModel.dll

Gibt an, ob der in der Actor Rolle handelnde Knoten diesen Header verstehen muss. Dies ist dem mustUnderstand SOAP-Header-Attribut zugeordnet.

public:
 property bool MustUnderstand { bool get(); void set(bool value); };

public bool MustUnderstand { get; set; }

member this.MustUnderstand : bool with get, set

Public Property MustUnderstand As Boolean

Eigenschaftswert

Boolean

true wenn der in der Actor Rolle handelnde Knoten diesen Header verstehen muss; andernfalls false.

Beispiele

Das folgende Codebeispiel zeigt die Verwendung des MessageHeaderAttribute SOAP-Headers für die Antwortnachricht mit den EigenschaftenName, Namespace die MustUnderstandfür diesen Header geeignet sind. Auf das Codebeispiel folgt ein Beispiel für die Nachricht, wenn sie gesendet wird.

 [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

Weitere Informationen finden Sie im Abschnitt "Hinweise" zu MessageHeaderAttribute Details.

Important

Es ist wichtig zu beachten, dass, wenn sich die MustUnderstand Eigenschaft in einer Nachricht befindet true , die gesendet wird, und die Anwendung auf der empfangenden Seite nicht versteht, dass der Header ein Fehler generiert wird. Wenn hingegen ein Header mit dem mustUnderstand SOAP-Header-Attributsatz true von Windows Communication Foundation (WCF) empfangen wird, muss er Teil des Nachrichtenvertrags sein (oder von einem der Windows Communication Foundation (WCF)-Kanäle verarbeitet werden. Andernfalls wird davon ausgegangen, dass der Header nicht verstanden wird und eine Ausnahme ausgelöst wird.