SoapHeader.MustUnderstand プロパティ

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

SoapHeader.MustUnderstand プロパティ

SoapHeader を認識する必要があるかどうかを示す値を取得または設定します。

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

Visual Basic (宣言)

Public Property MustUnderstand As
 Boolean

Visual Basic (使用法)

Dim instance As SoapHeader
Dim value As Boolean

value = instance.MustUnderstand

instance.MustUnderstand = value

C#

public bool MustUnderstand { get;
 set; }

C++

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

J#

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

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

JScript

public function get MustUnderstand
 () : boolean

public function set MustUnderstand
 (value : boolean)

プロパティ値
XML Web サービスが SoapHeader を適切に解釈して処理する必要がある場合は true。それ以外の場合は false。既定値は false です。

解説

XML Web サービス クライアントが MustUnderstand プロパティを true に設定して XML Web サービス メソッドの呼び出しに SOAP ヘッダーを追加すると、XML Web サービス メソッドは DidUnderstand プロパティを true に設定する必要があります。それ以外の場合は、ASP.NET が SoapHeaderException を XML Web サービス クライアントにスローします。

EncodedMustUnderstand プロパティと MustUnderstand プロパティの両方を使用して、SOAP ヘッダー内の mustUnderstand 属性の値を設定できますが、MustUnderstand プロパティでは、Boolean 値を使用して属性を設定できます。

クライアントへ SOAP ヘッダーを追加する場合の詳細については、「SOAP ヘッダーの使用」を参照してください。

使用例

XML Web サービス クライアントが、MyHeader 型のカスタム SOAP ヘッダーを定義し、MustUnderstand プロパティを true に設定して、MyWebMethod XML Web サービス メソッドを呼び出す例を次に示します。XML Web サービス メソッドが MyHeader SOAP ヘッダーの DidUnderstand プロパティを true に設定しない場合は、SoapHeaderException がスローされます。

Visual Basic

Imports System

Public Class Sample
    
    Public Shared Sub Main()
        Dim ws As New MyWebService()

        Try
            Dim customHeader As New
 MyHeader1()

            customHeader.MyValue = "Header Value for MyValue"
            customHeader.MustUnderstand = True

            ws.myHeader = customHeader

        Dim results As Integer

            results = ws.MyWebMethod(3,5)
        Catch e As Exception
            Console.WriteLine("Exception: {0}", e.ToString())
        End Try
    End Sub
End Class

C#

using System;

public class Sample {
    
    public static void Main()
 {
        MyWebService ws = new MyWebService();

        try {
            MyHeader customHeader = new MyHeader();
            customHeader.MyValue = "Header Value for MyValue";
            customHeader.MustUnderstand = true;
            ws.myHeader = customHeader;
            
        int results = ws.MyWebMethod(3,5);
        }
        catch (Exception e) {
            Console.WriteLine ("Exception: {0}", e.ToString());
        }
    }
}

C++

int main()
{
   MyWebService^ ws = gcnew MyWebService;
   try
   {
      MyHeader^ customHeader = gcnew MyHeader;
      customHeader->MyValue = "Header Value for MyValue";
      customHeader->MustUnderstand = true;
      ws->myHeader = customHeader;
      int results = ws->MyWebMethod( 3, 5 );
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "Exception: {0}", e );
   }

}

J#

import System.*;

public class Sample
{
    public static void main(String[]
 args)
    {
        MyWebService ws = new MyWebService();
        try {
            MyHeader customHeader = new MyHeader();
            customHeader.myValue = "Header Value for MyValue";
            customHeader.set_MustUnderstand(true);
            ws.myHeader = customHeader;
            int results = ws.MyWebMethod(3, 5);
        }
        catch (System.Exception e) {
            Console.WriteLine("Exception: {0}", e.ToString());
        }
    } //main
} //Sample

プラットフォーム

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 名前空間
SoapHeader.DidUnderstand プロパティ
SoapHeaderException