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 Web 服务定义了 类型MyHeader之一SoapHeader。 Hello XML Web 服务方法要求客户端使用此 SoapHeader调用 XML Web 服务方法。 Hello XML Web 服务还会捕获除 以外的MyHeader任何 SOAP 标头。

<%@ 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. 将成员添加到在步骤 1 中创建的类型的 XML Web 服务类或 XML Web 服务客户端代理类。

3. 将 应用于 SoapHeaderAttribute XML Web 服务方法或代理类中的相应方法，并指定在 属性的步骤 2 MemberName 中创建的成员。

4. 在 XML Web 服务方法或 XML Web 服务客户端代码中，访问 MemberName 属性以处理 SOAP 标头中发送的数据。

有关更多详细信息，请参阅 MemberName 属性。

另请参阅

• MemberName
• SoapHeader