WebMethodAttribute.Description Egenskap

Definition

Ett beskrivande meddelande som beskriver XML-webbtjänstmetoden.

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

Egenskapsvärde

Ett beskrivande meddelande som beskriver XML-webbtjänstmetoden. Standardvärdet är Empty.

Exempel

I exemplet nedan används strängen Obtains the Server Computer Name för att beskriva XML-webbtjänstmetoden på sidan Tjänstbeskrivning och tjänsthjälp för XML-webbtjänsten.

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

Kommentarer

Det beskrivande meddelandet visas för potentiella användare av XML-webbtjänsten när beskrivningsdokument för XML-webbtjänsten genereras, till exempel tjänstbeskrivningen och hjälpsidan för tjänsten.

Gäller för

Se även