WebMethodAttribute Class

.NET Framework (current version)

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

System.Object
System.Attribute
System.Web.Services.WebMethodAttribute

Syntax

C++

[AttributeUsageAttribute(AttributeTargets.Method)]
public sealed class WebMethodAttribute : Attribute

Constructors

	Name	Description
	WebMethodAttribute()	Initializes a new instance of the WebMethodAttribute class.
	WebMethodAttribute(Boolean)	Initializes a new instance of the WebMethodAttribute class.
	WebMethodAttribute(Boolean, TransactionOption)	Initializes a new instance of the WebMethodAttribute class.
	WebMethodAttribute(Boolean, TransactionOption, Int32)	Initializes a new instance of the WebMethodAttribute class.
	WebMethodAttribute(Boolean, TransactionOption, Int32, Boolean)	Initializes a new instance of the WebMethodAttribute class.

Properties

	Name	Description
	BufferResponse	Gets or sets whether the response for this request is buffered.
	CacheDuration	Gets or sets the number of seconds the response should be held in the cache.
	Description	A descriptive message describing the XML Web service method.
	EnableSession	Indicates whether session state is enabled for an XML Web service method.
	MessageName	The name used for the XML Web service method in the data passed to and returned from an XML Web service method.
	TransactionOption	Indicates the transaction support of an XML Web service method.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

Methods

	Name	Description
	Equals(Object)	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.)
	GetHashCode()	Returns the hash code for this instance.(Inherited from Attribute.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	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.)
	Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)
	_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)
	_Attribute.GetTypeInfoCount(UInt32)	Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)
	_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	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.

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.