WebServiceAttribute.Description Eigenschaft

Definition

Namespace:

System.Web.Services

Assembly:

System.Web.Services.dll

Eine beschreibende Meldung für den XML-Webdienst.

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

Der Text, der die Funktionalität des XML-Webdiensts beschreibt.

Beispiele

Im folgenden Beispiel wird die Description -Eigenschaft auf "Common Server Variables"festgelegt.

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

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

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