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 サービスは、 型の 1 つ SoapHeader を定義します MyHeader。 XML Web サービス メソッドでは Hello 、クライアント SoapHeaderがこの を使用して XML Web サービス メソッドを呼び出す必要があります。 XML Web サービスは Hello 、 以外 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. SOAP ヘッダーで渡されたデータを表すことから SoapHeader 派生するクラスを作成します。

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

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

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

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

コンストラクター

プロパティ

メソッド

明示的なインターフェイスの実装

適用対象

こちらもご覧ください

• MemberName
• SoapHeader