WebServiceAttribute.Description Property


A descriptive message for the XML Web service.

 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

Property Value

The text describing the functionality of the XML Web service.


The following example sets the Description property to "Common Server Variables".

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


The descriptive message is displayed to prospective consumers of the XML Web service when description documents for the XML Web service are generated, such as the Service Description and the Service help page.

Applies to

See also