SoapHeaderAttribute Класс

Определение

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

Наследование

Object

Attribute

SoapHeaderAttribute

Атрибуты

AttributeUsageAttribute

Примеры

Следующая MyWebService веб-служба XML определяет один из SoapHeader типов MyHeader. Метод Hello веб-службы XML требует, чтобы клиент вызвал метод веб-службы XML с помощью этого SoapHeaderметода . Веб-служба Hello XML также перехватывает все заголовки SOAP, отличные от 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

Комментарии

Ниже приведены основные шаги по получению и обработке заголовка SOAP.

1. Создайте класс, производный от SoapHeader , представляющий данные, переданные в заголовке SOAP.

2. Добавьте член в класс веб-службы XML или прокси-класс клиента веб-службы XML типа, созданного на шаге 1.

3. SoapHeaderAttribute Примените к методу веб-службы XML или соответствующему методу в прокси-классе, указав элемент, созданный на шаге 2, в свойстве MemberName .

4. В методе веб-службы XML или клиентском коде веб-службы XML получите доступ к свойству MemberName для обработки данных, отправленных в заголовке SOAP.

Дополнительные сведения см. в свойстве MemberName .

Конструкторы

Свойства

Методы

Явные реализации интерфейса

Применяется к

См. также раздел

• MemberName
• SoapHeader