WebMethodAttribute.MessageName プロパティとは何？わかりやすく解説 Weblio辞書

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

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

WebMethodAttribute.MessageName プロパティ

XML Web サービスメソッドへ渡されるデータ、および XML Web サービスメソッドから返されるデータ内で XML Web サービスメソッドに使用される名前。

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

Visual Basic (宣言)

Public Property MessageName As
 String

Visual Basic (使用法)

Dim instance As WebMethodAttribute
Dim value As String

value = instance.MessageName

instance.MessageName = value

public string MessageName { get;
 set; }

C++

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

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

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

JScript

public function get MessageName
 () : String

public function set MessageName
 (value : String)

プロパティ値
XML Web サービスメソッドへ渡されるデータ、および XML Web サービスメソッドから渡されるデータ内で XML Web サービスメソッドに使用される名前。既定値は、XML Web サービスメソッドの名前です。

解説

メソッド名またはプロパティ名にエイリアスを付けるには、MessageName プロパティを使用できます。MessageName プロパティの最も一般的な使用法は、ポリモーフィックメソッドを一意に識別することです。既定では、MessageName には XML Web サービスメソッドの名前が設定されます。このため、XML Web サービスに、同じ名前の 2 つ以上の XML Web サービスメソッドが含まれている場合は、コードで実際のメソッド名を変更するのではなく、MessageName に XML Web サービス内で一意となる名前を設定することによって、各 XML Web サービスメソッドを一意に識別できます。

データが XML Web サービスに渡される場合は要求内で送信され、データが XML Web サービスから返される場合は応答内で送信されます。要求内と応答内では、XML Web サービスメソッドに使用されている名前は、その MessageName プロパティの名前になります。

XML Web サービスメソッドに関連付けられているメッセージ名は、XML Web サービス内で一意である必要があります。

名前が同じでもパラメータが異なる新しい XML Web サービスメソッドが、クライアントが元のメソッドを呼び出した後に追加された場合、新しいメソッドには別のメッセージ名を指定する必要があります。しかし、元のメッセージ名は、既存のクライアントとの互換性を保持するために、残しておく必要があります。

使用例

MessageName を使用して、2 つの Add メソッドを明確に区別する例を次に示します。

Visual Basic

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

Imports System
Imports System.Web.Services

Public Class Calculator
    Inherits WebService
    
    ' The MessageName property defaults to Add for this XML Web service
 method.
    <WebMethod()> _
    Overloads Public Function
 Add(i As Integer, j As
 Integer) As Integer
        
        Return i + j
    End Function
    
    <WebMethod(MessageName := "Add2")> _
    Overloads Public Function
 Add(i As Integer, j As
 Integer, k As Integer) As Integer
        
        Return i + j + k
    End Function    
End Class

<%@ WebService Language="C#" Class="Calculator" %>
 
 using System;
 using System.Web.Services;
 
 public class Calculator : WebService {
    // The MessageName property defaults to Add for this XML Web service
 method.
    [WebMethod]
    public int Add(int i,
 int j) {
       return i + j;
    }   
    [WebMethod(MessageName="Add2")]
    public int Add(int i,
 int j, int k) {
       return i + j + k;
    }   
 }