WebMethodAttribute.Description Property

A descriptive message describing the XML Web service method.

Namespace: System.Web.Services
Assembly: System.Web.Services (in system.web.services.dll)

public:
property String^ Description {
	String^ get ();
	void set (String^ value);
}
/** @property */
public String get_Description ()

/** @property */
public void set_Description (String value)

public function get Description () : String

public function set Description (value : String)

Not applicable.

Property Value

A descriptive message describing the XML Web service method. The default value is String.Empty.

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.

In the example below, the string Obtains the Server Computer Name is used to describe the XML Web service method in the Service Description and Service help page for the XML Web service.

No code example is currently available or this language may not be supported.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show: