SoapHeaderAttribute 類別

定義

命名空間:

System.Web.Services.Protocols

組件:

System.Web.Services.dll

這個屬性 (Attribute) 會套用至 XML Web Service 方法或 XML Web Service 用戶端，以指定 Web 服務方法或 XML Web Service 用戶端可以處理的 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, Inherited=true)]
public sealed class SoapHeaderAttribute : Attribute

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

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

Public NotInheritable Class SoapHeaderAttribute
Inherits Attribute

繼承

Object

Attribute

SoapHeaderAttribute

屬性

AttributeUsageAttribute

範例

下列 MyWebService XML Web 服務會定義類型之 MyHeader 一 SoapHeader 。 HelloXML Web 服務方法需要用戶端使用這個 SoapHeader 叫用 XML Web 服務方法。 HelloXML 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 服務用戶端 Proxy 類別。

3. SoapHeaderAttribute將 套用至 XML Web 服務方法或 Proxy 類別中的對應方法，指定 在 屬性的步驟 2 MemberName 中建立的成員。

4. 在 XML Web 服務方法或 XML Web 服務用戶端程式代碼中，存取 MemberName 屬性以處理 SOAP 標頭中傳送的資料。

如需詳細資訊，請參閱 MemberName 屬性。

建構函式

SoapHeaderAttribute(String)

設定表示 SOAP 標頭內容的 XML Web Service 類別的成員，初始化 SoapHeaderAttribute 類別的新執行個體。

屬性

Direction	取得或設定 SOAP 標頭，是否要用於 XML Web Service、XML Web Service 用戶端或兩者都是。
MemberName	取得或設定 XML Web Service 類別的成員，表示 SOAP 標頭內容。
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)	將一組名稱對應至一組對應的分派識別項 (Dispatch Identifier)。 (繼承來源 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