WebMethodAttribute.Description プロパティ

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

WebMethodAttribute.Description プロパティ

XML Web サービス メソッドを説明する説明メッセージ。

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

Visual Basic (宣言)

Public Property Description As
 String

Visual Basic (使用法)

Dim instance As WebMethodAttribute
Dim value As String

value = instance.Description

instance.Description = value

C#

public string Description { get;
 set; }

C++

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

J#

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

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

JScript

public function get Description
 () : String

public function set Description
 (value : String)

プロパティ値
XML Web サービス メソッドを説明する説明メッセージ。既定値は String.Empty です。

解説

この説明メッセージは、サービスの説明やサービス ヘルプ ページなど、XML Web サービスを説明するドキュメントの生成時に、XML Web サービスの対象ユーザーに対して表示されます。

使用例

文字列 Obtains the Server Computer Name を使用して、XML Web サービスのサービスの説明およびサービス ヘルプ ページで、XML Web サービス メソッドを説明する例を次に示します。

Visual Basic

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

Imports System
Imports System.Web.Services

Public Class Util
    Inherits WebService

    <WebMethod(Description := "Obtains the Server Computer
 Name", _
        EnableSession := False)> _
    Public Function GetMachineName() As
 String
        
        Return Server.MachineName
    End Function
End Class

C#

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

プラットフォーム

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

参照

関連項目
WebMethodAttribute クラス
WebMethodAttribute メンバ
System.Web.Services 名前空間
WebMethodAttribute クラス