WebMethodAttribute Class
 

Adding this attribute to a method within an XML Web service created using ASP.NET makes the method callable from remote Web clients. This class cannot be inherited.

Namespace:   System.Web.Services
Assembly:  System.Web.Services (in System.Web.Services.dll)

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.Web.ServicesWebMethodAttribute

Syntax
[AttributeUsageAttribute(AttributeTargets.Method)]
public sealed class WebMethodAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Method)]
public ref class WebMethodAttribute sealed : Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Method)>]
type WebMethodAttribute = 
    class
        inherit Attribute
    end
<AttributeUsageAttribute(AttributeTargets.Method)>
Public NotInheritable Class WebMethodAttribute
	Inherits Attribute
Constructors
NameDescription
System_CAPS_pubmethod WebMethodAttribute

Initializes a new instance of the WebMethodAttribute class.

System_CAPS_pubmethod WebMethodAttribute

Initializes a new instance of the WebMethodAttribute class.

System_CAPS_pubmethod WebMethodAttribute

Initializes a new instance of the WebMethodAttribute class.

System_CAPS_pubmethod WebMethodAttribute

Initializes a new instance of the WebMethodAttribute class.

System_CAPS_pubmethod WebMethodAttribute

Initializes a new instance of the WebMethodAttribute class.

Properties
NameDescription
System_CAPS_pubproperty

Gets or sets whether the response for this request is buffered.

System_CAPS_pubproperty

Gets or sets the number of seconds the response should be held in the cache.

System_CAPS_pubproperty

A descriptive message describing the XML Web service method.

System_CAPS_pubproperty

Indicates whether session state is enabled for an XML Web service method.

System_CAPS_pubproperty

The name used for the XML Web service method in the data passed to and returned from an XML Web service method.

System_CAPS_pubproperty

Indicates the transaction support of an XML Web service method.

System_CAPS_pubproperty

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

Methods
NameDescription
System_CAPS_pubmethod Equals

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod GetHashCode

Returns the hash code for this instance.(Inherited from Attribute.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod IsDefaultAttribute

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)

System_CAPS_pubmethod Match

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

Explicit Interface Implementations
NameDescription
System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetIDsOfNames

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfo

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfoCount

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeInvoke

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

Remarks

Methods within a class that have this attribute set are called XML Web service methods. The method and class must be public and running inside an ASP.NET Web application.

Examples

In the example below the method GetMachineName can be remotely called across the Web, because it has a WebMethodAttribute. GetUserName cannot be called remotely, because it does not have a WebMethodAttribute, even though it is public.


  
Version Information
.NET Framework
Available since 1.1
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top