WebServiceAttribute.Description プロパティ

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

WebServiceAttribute.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 WebServiceAttribute
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 サービスの機能を説明するテキスト。

解説

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

使用例

Description プロパティを "Common Server Variables" に設定する例を次に示します。

Visual Basic

<%@ WebService Language="VB" Class=
 "ServerVariables"%>
 
Imports System
Imports System.Web.Services

<WebService(Description := "Common Server Variables",
 _
 Namespace := "http://www.contoso.com/")>
 _
Public Class ServerVariables
    Inherits WebService 
    
    <WebMethod(Description := "Obtains the Computer Machine
 Name", _
        EnableSession := False)> _
    Public Function GetMachineName() As
 String
        
        Return Server.MachineName
    End Function
End Class
 

C#

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

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