SoapHeaderAttribute Klass

Definition

public ref class SoapHeaderAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=true)]
public sealed class SoapHeaderAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=true)>]
type SoapHeaderAttribute = class
    inherit Attribute

Public NotInheritable Class SoapHeaderAttribute
Inherits Attribute

Arv

Object

Attribute

SoapHeaderAttribute

Attribut

AttributeUsageAttribute

Exempel

Följande MyWebService XML-webbtjänst definierar en SoapHeader av typen MyHeader. XML-webbtjänstmetoden Hello kräver att klienten anropar XML-webbtjänstmetoden med den här SoapHeader. Hello XML-webbtjänsten fångar även alla SOAP-huvuden förutom MyHeader.

<%@ WebService Language="C#" Class="MyWebService"%>
using System.Web.Services;
using System.Web.Services.Protocols;

// Define a SOAP header by deriving from the SoapHeader base class.
// The header contains just one string value.
public class MyHeader : SoapHeader {
    public string MyValue;
}

public class MyWebService {
    // Member variable to receive the contents of the MyHeader SoapHeader.
    public MyHeader myHeader;

    // Member variable to receive all headers other than MyHeader.
    public SoapUnknownHeader[] unknownHeaders;
 
    [WebMethod]
    [SoapHeader("myHeader", Direction=SoapHeaderDirection.InOut)]

    // Receive any SOAP headers other than MyHeader.
    [SoapHeader("unknownHeaders")]
    public void Hello() {

       // Process the MyHeader SoapHeader.
       if (myHeader.MyValue == "Some string") {
          // Process the header.
       }
       foreach (SoapHeader header in unknownHeaders) {
           // Perform some processing on header.
           
           // For those headers that cannot be processed,
           // set the DidUnderstand property to false.
           header.DidUnderstand = false;
       }
    }
}

<%@ WebService Language="VB" Class="MyWebService"%>
Imports System.Web.Services
Imports System.Web.Services.Protocols

' Define a SOAP header by deriving from the SoapHeader base class.
' The header contains just one string value.
Public Class MyHeader
    Inherits SoapHeader
    Public MyValue As String
End Class

Public Class MyWebService
    ' Member variable to receive the contents of the MyHeader SoapHeader.
    Public myHeader As MyHeader
    
    ' Member variable to receive all headers other than MyHeader.
    Public unknownHeaders() As SoapUnknownHeader
    
    ' Receive any SOAP headers other than MyHeader.
    <WebMethod, _
        SoapHeader("myHeader", Direction := SoapHeaderDirection.InOut), _
        SoapHeader("unknownHeaders")> _
    Public Sub Hello()        
        
        ' Process the MyHeader SoapHeader.
        If myHeader.MyValue = "Some string" Then
            ' Process the header.
        End If 
        Dim header As SoapHeader
        For Each header In  unknownHeaders
            ' Perform some processing on header
            ' For those headers that cannot be processed, 
            ' set the DidUnderstand to false.
            header.DidUnderstand = False
        Next header
    End Sub
End Class

Kommentarer

De grundläggande stegen för att ta emot och bearbeta en SOAP-rubrik är:

1. Skapa en klass som härleds från SoapHeader att representera de data som skickas i SOAP-huvudet.

2. Lägg till en medlem i XML-webbtjänstklassen eller XML-webbtjänstklientproxyklassen av den typ som skapades i steg 1.

3. Använd en SoapHeaderAttribute på XML-webbtjänstmetoden eller motsvarande metod i proxyklassen och ange den medlem som skapades i steg 2 i MemberName egenskapen.

4. I XML-webbtjänstmetoden eller XML-webbtjänstklientkoden kommer du åt MemberName egenskapen för att bearbeta data som skickas i SOAP-huvudet.

Mer information finns i egenskapen MemberName .

Se även

• MemberName
• SoapHeader