WebMethodAttribute.Description Eigenschaft

Definition

Namespace:

System.Web.Services

Assembly:

System.Web.Services.dll

Eine beschreibende Meldung für die XML-Webdienstmethode.

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

public string Description { get; set; }

member this.Description : string with get, set

Public Property Description As String

Eigenschaftswert

String

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

Beispiele

Im folgenden Beispiel wird die Zeichenfolge Obtains the Server Computer Name verwendet, um die XML-Webdienstmethode auf der Hilfeseite Dienstbeschreibung und Dienst für den XML-Webdienst zu beschreiben.

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

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

Hinweise

Die beschreibende Nachricht wird potenziellen Consumern des XML-Webdiensts angezeigt, wenn Beschreibungsdokumente für den XML-Webdienst generiert werden, z. B. die Dienstbeschreibung und die Hilfeseite des Diensts.

Weitere Informationen

• WebMethodAttribute