SoapHeaderAttribute クラス

.NET Framework クラス ライブラリ リファレンス

SoapHeaderAttribute クラス

この属性は、XML Web サービス メソッドまたは XML Web サービス クライアントに適用され、XML Web サービス メソッドまたは XML Web サービス クライアントが処理できる SOAP ヘッダーを指定します。このクラスは継承できません。

名前空間: System.Web.Services.Protocols
アセンブリ: System.Web.Services (system.web.services.dll 内)
構文

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple:=True)> _
Public NotInheritable Class
 SoapHeaderAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As SoapHeaderAttribute

C#

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

C++

[AttributeUsageAttribute(AttributeTargets::Method, AllowMultiple=true)]
 
public ref class SoapHeaderAttribute sealed
 : public Attribute

J#

/** @attribute AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple=true)
 */ 
public final class SoapHeaderAttribute extends
 Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple=true)
 
public final class SoapHeaderAttribute extends
 Attribute

解説

SOAP ヘッダーの受信および処理の基本手順は次のとおりです。

1. SOAP ヘッダーに渡されたデータを表す SoapHeader から派生したクラスを作成します。

2. XML Web サービス クラスまたは XML Web サービス クライアント プロキシ クラスに手順 1 で作成した型のメンバを追加します。

3. 手順 2 で作成したメンバを MemberName プロパティで指定して、XML Web サービス メソッドまたはプロキシ クラス内の対応するメソッドに SoapHeaderAttribute を適用します。

4. XML Web サービス メソッドまたは XML Web サービス クライアント コード内で、MemberName プロパティにアクセスし、SOAP ヘッダーに送信されたデータを処理します。

詳細については、MemberName プロパティのトピックを参照してください。

使用例

MyHeader 型の 1 つの SoapHeader を定義する MyWebService XML Web サービスを次に示します。Hello XML Web サービス メソッドは、クライアントがこの SoapHeader で XML Web サービス メソッドを呼び出すことを要求します。Hello XML Web サービスは、MyHeader 以外の任意の SOAP ヘッダーも受け取ります。

Visual Basic

<%@ 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

C#

<%@ 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;
       }
    }
}

継承階層

System.Object
   System.Attribute
    System.Web.Services.Protocols.SoapHeaderAttribute

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
SoapHeaderAttribute メンバ
System.Web.Services.Protocols 名前空間
MemberName
SoapHeader クラス