WebMethodAttribute クラスとは何？わかりやすく解説 Weblio辞書

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

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

WebMethodAttribute クラス

ASP.NET で作成された XML Web サービス内でこの属性をメソッドに追加すると、リモートの Web クライアントから該当するメソッドを呼び出すことができます。このクラスは継承できません。

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

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Method)> _
Public NotInheritable Class
 WebMethodAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As WebMethodAttribute

[AttributeUsageAttribute(AttributeTargets.Method)] 
public sealed class WebMethodAttribute : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Method)] 
public ref class WebMethodAttribute sealed
 : public Attribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Method) */ 
public final class WebMethodAttribute extends
 Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Method) 
public final class WebMethodAttribute extends
 Attribute

解説

この属性が設定されているクラス内のメソッドは、XML Web サービスメソッドと呼ばれます。このメソッドとクラスはパブリックとして指定し、ASP.NET Web アプリケーション内部で実行する必要があります。

Topic	Location
チュートリアル : Visual Web Developer での ASP.NET Web サービスの作成と使用	Visual Studio での ASP .NET Web アプリケーションの作成

使用例

WebMethodAttribute が設定されているためメソッド GetMachineName を Web 経由でリモートから呼び出すことができる例を次に示します。GetUserName は public ですが、WebMethodAttribute が設定されていないためリモートから呼び出すことはできません。

Visual Basic

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

Imports System
Imports System.Web.Services

Public Class Util
    Inherits WebService
    
    Public Function GetUserName() As
 String
        Return User.Identity.Name
    End Function    
    
    <WebMethod(Description := "Obtains the Server Machine Name",
 _
        EnableSession := True)> _
    Public Function GetMachineName() As
 String
        
        Return Server.MachineName
    End Function
End Class

<%@ WebService Language="C#" Class="Util"%>
    using System;
    using System.Web.Services;
    public class Util: WebService {
       public string GetUserName() {
          return User.Identity.Name;
       }
    
       [ WebMethod(Description="Obtains the Server Machine Name",
       EnableSession=true)]
       public string GetMachineName() {
          return Server.MachineName;
       }
    }