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.
Assembly: System.Web.Services (in System.Web.Services.dll)
<[%$TOPIC/28a537td_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/28a537td_en-us_VS_110_2_0_0_0_1%].Method)> _
Public NotInheritable Class WebMethodAttribute _
Inherits [%$TOPIC/28a537td_en-us_VS_110_2_0_0_0_2%]
[[%$TOPIC/28a537td_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/28a537td_en-us_VS_110_2_0_1_0_1%].Method)]
public sealed class WebMethodAttribute : [%$TOPIC/28a537td_en-us_VS_110_2_0_1_0_2%]
[[%$TOPIC/28a537td_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/28a537td_en-us_VS_110_2_0_2_0_1%]::Method)]
public ref class WebMethodAttribute sealed : public [%$TOPIC/28a537td_en-us_VS_110_2_0_2_0_2%]
[<[%$TOPIC/28a537td_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/28a537td_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/28a537td_en-us_VS_110_2_0_3_0_2%].Method)>]
type WebMethodAttribute =
class
inherit [%$TOPIC/28a537td_en-us_VS_110_2_0_3_0_3%]
end
The WebMethodAttribute type exposes the following members.
| 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. |
| 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.) |
| Name | Description | |
|---|---|---|
![]() | Equals | Infrastructure. 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 | 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.) |
| Name | Description | |
|---|---|---|
![]() | _AttributeGetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) |
![]() | _AttributeGetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) |
![]() | _AttributeGetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) |
![]() | _AttributeInvoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
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.
<%@ WebService Language="VB" Class="Util"%>
Imports System
Imports System.Web.Services
Public Class Util
Inherits WebService
Public Function GetUserName() As String
Return User.Identity.Name
End Function
<WebMethod(Description := "Obtains the Server Machine Name", _
EnableSession := True)> _
Public Function GetMachineName() As String
Return Server.MachineName
End Function
End Class
<%@ WebService Language="C#" Class="Util"%>
using System;
using System.Web.Services;
public class Util: WebService {
public string GetUserName() {
return User.Identity.Name;
}
[ WebMethod(Description="Obtains the Server Machine Name",
EnableSession=true)]
public string GetMachineName() {
return Server.MachineName;
}
}
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.gif)
.gif)
.gif)