WebMethodAttribute.MessageName プロパティ

定義

名前空間:

System.Web.Services

アセンブリ:

System.Web.Services.dll

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

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

public string MessageName { get; set; }

member this.MessageName : string with get, set

Public Property MessageName As String

プロパティ値

String

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

例

次の例では、 MessageName 2 つの Add メソッドを明確にするために使用します。

<%@ 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;
    }   
 }

<%@ 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

注釈

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

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

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

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

こちらもご覧ください

• WebMethodAttribute