WebMethodAttribute.Description Propriedade
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Uma mensagem descritiva que descreve o método do serviço Web XML.
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
Valor de Propriedade
Uma mensagem descritiva que descreve o método do serviço Web XML. O valor predefinido é Empty.
Exemplos
No exemplo abaixo, a cadeia Obtains the Server Computer Name é usada para descrever o método do serviço Web XML na página de Descrição do Serviço e Ajuda do Serviço para o serviço Web XML.
<%@ 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
Observações
A mensagem descritiva é apresentada aos potenciais consumidores do serviço Web XML quando são gerados documentos de descrição para o serviço Web XML, como a Descrição do Serviço e a página de ajuda do Serviço.