SoapHeaderDirection 列挙体とは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

SoapHeaderDirection 列挙体

SoapHeader の受信者が XML Web サービス、XML Web サービスクライアント、またはその両方のいずれであるかを指定します。

この列挙体には、メンバ値のビットごとの組み合わせを可能にする FlagsAttribute 属性が含まれています。

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

Visual Basic (宣言)

<FlagsAttribute> _
Public Enumeration SoapHeaderDirection

Visual Basic (使用法)

Dim instance As SoapHeaderDirection

[FlagsAttribute] 
public enum SoapHeaderDirection

C++

[FlagsAttribute] 
public enum class SoapHeaderDirection

/** @attribute FlagsAttribute() */ 
public enum SoapHeaderDirection

JScript

FlagsAttribute 
public enum SoapHeaderDirection

メンバ

	メンバ名	説明
	Fault	XML Web サービスメソッドによって例外がスローされたときに SoapHeader を XML Web サービスクライアントに送信するように指定します。
	In	SoapHeader を XML Web サービスに送信するように指定します。
	InOut	SoapHeader を XML Web サービスと XML Web サービスクライアントの両方に送信するように指定します。
	Out	SoapHeader を XML Web サービスクライアントに送信するように指定します。

解説

SoapHeaderAttribute は、XML Web サービスメソッドまたは XML Web サービスのプロキシクラスのメソッドに適用できます。どちらの場合も、受信者は SoapHeaderAttribute の Direction プロパティによって指定されます。実行時に例外がスローされたとき、XML Web サービスメソッドが SOAP ヘッダーを返すよう設定するには、SoapHeaderAttribute をメソッドに適用し、Direction プロパティを Fault に設定します。

.NET Framework の Version 1.0 は Fault 値をサポートしていません。

使用例

XML Web サービスメソッドの実行時にスローされる例外にかかわらず、myHeaderSoapHeader が XML Web サービスクライアントから XML Web サービスに送信されてから、再び XML Web サービスクライアントに返されるように指定する XML Web サービスメソッドを次に示します。

Visual Basic

Public Class MyHeader
    Inherits SoapHeader
    Public MyValue As String
End Class

Public Class MyWebService
    
    Public myHeader As MyHeader    
    
    <WebMethod, _
    SoapHeader("myHeader", _
                Direction := SoapHeaderDirection.InOut Or SoapHeaderDirection.Fault)>
 _
    Public Sub MySoapHeaderReceivingMethod()

        ' Set myHeader.MyValue to some value.
        
    End Sub
    
End Class

public class MyHeader : SoapHeader {
    public string MyValue;
}

public class MyWebService {

    public MyHeader myHeader;

    [WebMethod]
    [SoapHeader("myHeader", 
                Direction=SoapHeaderDirection.InOut | SoapHeaderDirection.Fault)]
    public void MySoapHeaderReceivingMethod()
 {

        // Set myHeader.MyValue to some value.

    }
}

C++

public ref class MyHeader: public
 SoapHeader
{
public:
   String^ MyValue;
};

public ref class MyWebService
{
public:
   MyHeader^ myHeader;

   [WebMethod]
   [SoapHeader("myHeader",
   Direction=SoapHeaderDirection::InOut|SoapHeaderDirection::Fault)]
   void MySoapHeaderReceivingMethod()
   {
      
      // Set myHeader->MyValue to some value.
   }

};

public class MyHeader extends SoapHeader
{
    public String myValue;
} //MyHeader

public class MyWebService
{
    public MyHeader myHeader;

    /** @attribute WebMethod()
     */
    /** @attribute SoapHeader("myHeader", Direction = 
         SoapHeaderDirection.InOut | SoapHeaderDirection.Fault)
     */

    public void MySoapHeaderReceivingMethod()
    {
        // Set myHeader.myValue to some value.
    } //MySoapHeaderReceivingMethod
} //MyWebService