WebMethodAttribute.Description Eigenschap

Definitie

Een beschrijvend bericht waarin de XML-webservicemethode wordt beschreven.

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

Waarde van eigenschap

Een beschrijvend bericht waarin de XML-webservicemethode wordt beschreven. De standaardwaarde is Empty.

Voorbeelden

In het onderstaande voorbeeld wordt de tekenreeks Obtains the Server Computer Name gebruikt om de XML-webservicemethode te beschrijven op de Help-pagina Servicebeschrijving en Service voor de XML-webservice.

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

Opmerkingen

Het beschrijvende bericht wordt weergegeven aan potentiƫle gebruikers van de XML-webservice wanneer beschrijvingsdocumenten voor de XML-webservice worden gegenereerd, zoals de servicebeschrijving en de Help-pagina van de service.

Van toepassing op

Zie ook