WebMethodAttribute.Description-Eigenschaft

Eine beschreibende Meldung für die XML-Webdienstmethode.

Namespace: System.Web.Services
Assembly: System.Web.Services (in system.web.services.dll)

Syntax

'Declaration
Public Property Description As String
'Usage
Dim instance As WebMethodAttribute
Dim value As String

value = instance.Description

instance.Description = value

public string Description { get; set; }

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

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

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

public function get Description () : String

public function set Description (value : String)

Eigenschaftenwert

Eine beschreibende Meldung für die XML-Webdienstmethode. Der Standardwert ist String.Empty.

Hinweise

Die beschreibende Meldung wird jedem potenziellen Consumer des XML-Webdiensts angezeigt, wenn beschreibende Dokumente für den XML-Webdienst erstellt werden, z. B. die Dienstbeschreibung und die Hilfeseite Dienst.

Beispiel

Im folgenden Beispiel wird die XML-Webdienstmethode mit der Zeichenfolge Obtains the Server Computer Name in der Dienstbeschreibung und der Hilfeseite Dienst für den Webdienst beschrieben.

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

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

Plattformen

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile für Pocket PC, Windows Mobile für Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

.NET Compact Framework

Unterstützt in: 2.0, 1.0

Siehe auch

Referenz

WebMethodAttribute-Klasse
WebMethodAttribute-Member
System.Web.Services-Namespace
WebMethodAttribute-Klasse