SoapHeader.DidUnderstand プロパティ

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

SoapHeader.DidUnderstand プロパティ

XML Web サービス メソッドで SOAP ヘッダーを適切に処理したかどうかを示す値を取得または設定します。

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

Visual Basic (宣言)

Public Property DidUnderstand As
 Boolean

Visual Basic (使用法)

Dim instance As SoapHeader
Dim value As Boolean

value = instance.DidUnderstand

instance.DidUnderstand = value

C#

public bool DidUnderstand { get;
 set; }

C++

public:
property bool DidUnderstand {
    bool get ();
    void set (bool value);
}

J#

/** @property */
public boolean get_DidUnderstand ()

/** @property */
public void set_DidUnderstand (boolean value)

JScript

public function get DidUnderstand
 () : boolean

public function set DidUnderstand
 (value : boolean)

プロパティ値
SOAP ヘッダーが適切に処理された場合は true。それ以外の場合は false。

解説

XML Web サービスで定義されている SOAP ヘッダーの場合、ASP.NET では XML Web サービス メソッドが SOAP ヘッダーを適切に処理したことを前提として DidUnderstand の初期値を true に設定します。XML Web サービスで定義されていない SOAP ヘッダーの場合、初期値は false になります。XML Web サービス メソッドに渡された SOAP ヘッダーの DidUnderstand が false に設定されていることをメソッドが返した後に ASP.NET で検出した場合は、XML Web サービス メソッドの結果ではなく SoapHeaderException が XML Web サービス クライアントにスローされます。

使用例

MyWebService XML Web サービスが MyHeader SOAP ヘッダーを定義し、MyWebMethod XML Web サービス メソッドへの呼び出しと共に送信されるようにする例を次に示します。また、MyWebMethod が MyHeader SOAP ヘッダー以外のすべての SOAP ヘッダーを受信します。MyWebMethod が処理できる SOAP ヘッダーの場合、DidUnderstand は true に設定されています。

Visual Basic

<%@ WebService Language="VB" Class="MyWebService"%>

Imports System.Web.Services
Imports System.Web.Services.Protocols
Imports System.Xml
Imports System

' Define a SOAP header by deriving from the SoapHeader base class.
Public Class MyHeader
    Inherits SoapHeader
    Public MyValue As String
End Class

Public Class MyWebService
    
    Public theHeader As MyHeader
    ' Receive all SOAP headers besides the MyHeader SOAP header.
    Public unknownHeaders() As SoapUnknownHeader
    

    'Receive any SOAP headers other than MyHeader.    
    <WebMethod, _
     SoapHeader("theHeader", Direction := SoapHeaderDirection.InOut),
 _
     SoapHeader("unknownHeaders")> _
    Public Function MyWebMethod() As
 String
                
        Dim header As SoapUnknownHeader
        For Each header In
 unknownHeaders
            ' Perform some processing on the header.
            If header.Element.Name = "MyKnownHeader"
 Then
                header.DidUnderstand = True
            Else
                ' For those headers that cannot be
                ' processed, set the DidUnderstand propert to false.
                header.DidUnderstand = False
            End If
        Next header
        Return "Hello"
    End Function
    
End Class

C#

<%@ WebService Language="C#" Class="MyWebService"%>
using System.Web.Services;
using System.Web.Services.Protocols;
using System.Xml;
using System;

// Define a SOAP header by deriving from the SoapHeader base class.

public class MyHeader : SoapHeader {
    public string MyValue;
}

public class MyWebService {

    public MyHeader myHeader;
    // Receive all SOAP headers besides the MyHeader SOAP header.
    public SoapUnknownHeader[] unknownHeaders;
 
    [WebMethod]
    [SoapHeader("myHeader", Direction=SoapHeaderDirection.InOut)]

    //Receive any SOAP headers other than MyHeader.
    [SoapHeader("unknownHeaders",Required=false)]

    public string MyWebMethod() {

       foreach (SoapUnknownHeader header in
 unknownHeaders) {
           // Perform some processing on the header.
       if (header.Element.Name == "MyKnownHeader")
               header.DidUnderstand = true;
       else
                // For those headers that cannot be  
                // processed, set the DidUnderstand property to false.
                header.DidUnderstand = false;
       }
       return "Hello";
    }
}

プラットフォーム

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

参照

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