SoapHeaderAttribute.MemberName プロパティ

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

SoapHeaderAttribute.MemberName プロパティ

SOAP ヘッダーの内容を表す XML Web サービス クラスのメンバを取得または設定します。

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

Visual Basic (宣言)

Public Property MemberName As
 String

Visual Basic (使用法)

Dim instance As SoapHeaderAttribute
Dim value As String

value = instance.MemberName

instance.MemberName = value

C#

public string MemberName { get;
 set; }

C++

public:
property String^ MemberName {
    String^ get ();
    void set (String^ value);
}

J#

/** @property */
public String get_MemberName ()

/** @property */
public void set_MemberName (String value)

JScript

public function get MemberName
 () : String

public function set MemberName
 (value : String)

プロパティ値
SOAP ヘッダーの内容を表す XML Web サービス クラスのメンバ。既定値はありません。

解説

XML Web サービスまたは XML Web サービス クライアントは、XML Web サービス クラスの XML Web サービス メソッドまたはプロキシ クラスの対応するメソッドに SoapHeaderAttribute を適用することにより、処理する SOAP ヘッダーを指定できます。XML Web サービス メソッドが SOAP ヘッダーの内容を受信するには、SoapHeader から派生する型の XML Web サービス クラスにメンバを追加します。同様に、XML Web サービス クライアントは SoapHeader から派生するプロキシ クラスにメンバを追加します。SoapHeader から派生する Type は、SOAP ヘッダーの内容を表し、SOAP ヘッダーを受信する必要がある XML Web サービスまたは XML Web サービス クライアントの開発者によって作成されます。クラスが作成されると、MemberName プロパティを使用して SOAP ヘッダーの内容を受信するメンバを指定する、XML Web サービス メソッドまたは XML Web サービス クライアント プロキシ クラスの対応するメソッドに SoapHeaderAttribute を適用できます。

XML Web サービス メソッドは、XML Web サービス クラスまたは XML Web サービス プロキシ クラスに複数のメンバを追加し、複数の SoapHeaderAttribute 属性を XML Web サービス メソッドに適用することにより、複数の SOAP ヘッダーを受信できます。

XML Web サービスの書き込み時に不明な SOAP ヘッダーの受信や処理を行うには、メンバの型を SoapUnknownHeader、SoapHeader、またはどちらかのクラスの配列に指定します。

使用例

MyHeader 型の 1 つの SoapHeader を定義する MyWebService XML Web サービスを次に示します。Hello XML Web サービス メソッドは、myHeader メンバを MemberName プロパティとして指定し、XML Web サービス メソッドに渡された MyHeader SOAP ヘッダーの内容を受け取ります。

Visual Basic

Imports System
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 'MyHeader


Public Class MyWebService
   ' Member variable to receive the contents of the MyHeader SOAP header.
   Public myHeader As MyHeader

   
   <WebMethod, _ 
    SoapHeader("myHeader", Direction := SoapHeaderDirection.InOut)>
 _
   Public Sub Hello()

   End Sub 'Hello
End Class 'MyWebService

C#

using System;
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 SOAP
 header.
    public MyHeader myHeader;
 
    [WebMethod]
    [SoapHeader("myHeader", Direction=SoapHeaderDirection.InOut)]
    public void Hello() {
    
    }
}

C++

#using <System.EnterpriseServices.dll>
#using <System.Web.Services.dll>

using namespace System;
using namespace System::Web::Services;
using namespace System::Web::Services::Protocols;

// Define a SOAP header by deriving from the SoapHeader base class.
// The header contains just one string value.
public ref class MyHeader: public
 SoapHeader
{
public:
   String^ MyValue;
};

public ref class MyWebService
{
public:

   // Member variable to receive the contents of the MyHeader SOAP header.
   MyHeader^ myHeader;

   [WebMethod]
   [SoapHeader("myHeader",Direction=SoapHeaderDirection::InOut)]
   void Hello(){}

};

J#

import System.*;
import System.Web.Services.*;
import 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 extends SoapHeader
{
    public String myValue;
} //MyHeader

public class MyWebService
{
    // Member variable to receive the contents of the MyHeader SOAP
 header.
    public MyHeader myHeader;

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

    public void Hello()
    {
    } //Hello
} //MyWebService

プラットフォーム

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 クラス
SoapHeaderAttribute メンバ
System.Web.Services.Protocols 名前空間