SoapHeaderAttribute 类

定义

命名空间:

System.Web.Services.Protocols

程序集:

System.Web.Services.dll

此特性应用于 XML Web services 方法或 XML Web services 客户端，用以指定该 XML Web services 方法或 XML Web services 客户端可以处理的 SOAP 标头。 此类不能被继承。

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 属性。

构造函数

SoapHeaderAttribute(String)

通过设置表示 SOAP 标头内容的 XML Web services 类的成员，初始化 SoapHeaderAttribute 类的新实例。

属性

Direction	获取或设置 SOAP 标头是用于 XML Web services 还是 XML Web services 客户端，或同时用于二者。
MemberName	获取或设置表示 SOAP 标头内容的 XML Web services 类的成员。
Required	已过时. 此成员已经过时，不具有任何功能。
TypeId	在派生类中实现时，获取此 Attribute 的唯一标识符。 (继承自 Attribute)

方法

Equals(Object)	返回一个值，该值指示此实例是否与指定的对象相等。 (继承自 Attribute)
GetHashCode()	返回此实例的哈希代码。 (继承自 Attribute)
GetType()	获取当前实例的 Type。 (继承自 Object)
IsDefaultAttribute()	在派生类中重写时，指示此实例的值是否是派生类的默认值。 (继承自 Attribute)
Match(Object)	当在派生类中重写时，返回一个指示此实例是否等于指定对象的值。 (继承自 Attribute)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
ToString()	返回表示当前对象的字符串。 (继承自 Object)

显式接口实现

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	将一组名称映射为对应的一组调度标识符。 (继承自 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	检索对象的类型信息，然后可以使用该信息获取接口的类型信息。 (继承自 Attribute)
_Attribute.GetTypeInfoCount(UInt32)	检索对象提供的类型信息接口的数量（0 或 1）。 (继承自 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	提供对某一对象公开的属性和方法的访问。 (继承自 Attribute)

另请参阅

• MemberName
• SoapHeader