WebMethodAttribute WebMethodAttribute WebMethodAttribute WebMethodAttribute Class

Definición

Cuando este atributo se agrega a un método en un servicio Web XML creado mediante ASP.NET, el método es invocable desde clientes Web remotos.Adding this attribute to a method within an XML Web service created using ASP.NET makes the method callable from remote Web clients. Esta clase no puede heredarse.This class cannot be inherited.

public ref class WebMethodAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Method, Inherited=true)]
[System.AttributeUsage(System.AttributeTargets.Method)]
public sealed class WebMethodAttribute : Attribute
type WebMethodAttribute = class
    inherit Attribute
Public NotInheritable Class WebMethodAttribute
Inherits Attribute
Herencia
WebMethodAttributeWebMethodAttributeWebMethodAttributeWebMethodAttribute
Atributos

Ejemplos

En el ejemplo siguiente, se GetMachineName puede llamar al método de forma remota a través de Web, porque WebMethodAttributetiene un.In the example below the method GetMachineName can be remotely called across the Web, because it has a WebMethodAttribute. GetUserNameno se puede llamar a de forma remota porque no tiene un WebMethodAttribute, aunque es. publicGetUserName cannot be called remotely, because it does not have a WebMethodAttribute, even though it is public.

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

Comentarios

Los métodos de una clase que tienen este atributo establecido se denominan métodos de servicios Web XML.Methods within a class that have this attribute set are called XML Web service methods. El método y la clase deben ser públicos y ejecutarse dentro de una aplicación Web ASP.NET.The method and class must be public and running inside an ASP.NET Web application.

Constructores

WebMethodAttribute() WebMethodAttribute() WebMethodAttribute() WebMethodAttribute()

Inicializa una nueva instancia de la clase WebMethodAttribute.Initializes a new instance of the WebMethodAttribute class.

WebMethodAttribute(Boolean) WebMethodAttribute(Boolean) WebMethodAttribute(Boolean) WebMethodAttribute(Boolean)

Inicializa una nueva instancia de la clase WebMethodAttribute.Initializes a new instance of the WebMethodAttribute class.

WebMethodAttribute(Boolean, TransactionOption) WebMethodAttribute(Boolean, TransactionOption) WebMethodAttribute(Boolean, TransactionOption) WebMethodAttribute(Boolean, TransactionOption)

Inicializa una nueva instancia de la clase WebMethodAttribute.Initializes a new instance of the WebMethodAttribute class.

WebMethodAttribute(Boolean, TransactionOption) WebMethodAttribute(Boolean, TransactionOption) WebMethodAttribute(Boolean, TransactionOption) WebMethodAttribute(Boolean, TransactionOption)
WebMethodAttribute(Boolean, TransactionOption, Int32) WebMethodAttribute(Boolean, TransactionOption, Int32) WebMethodAttribute(Boolean, TransactionOption, Int32) WebMethodAttribute(Boolean, TransactionOption, Int32)

Inicializa una nueva instancia de la clase WebMethodAttribute.Initializes a new instance of the WebMethodAttribute class.

WebMethodAttribute(Boolean, TransactionOption, Int32) WebMethodAttribute(Boolean, TransactionOption, Int32) WebMethodAttribute(Boolean, TransactionOption, Int32) WebMethodAttribute(Boolean, TransactionOption, Int32)
WebMethodAttribute(Boolean, TransactionOption, Int32, Boolean) WebMethodAttribute(Boolean, TransactionOption, Int32, Boolean) WebMethodAttribute(Boolean, TransactionOption, Int32, Boolean) WebMethodAttribute(Boolean, TransactionOption, Int32, Boolean)

Inicializa una nueva instancia de la clase WebMethodAttribute.Initializes a new instance of the WebMethodAttribute class.

WebMethodAttribute(Boolean, TransactionOption, Int32, Boolean) WebMethodAttribute(Boolean, TransactionOption, Int32, Boolean) WebMethodAttribute(Boolean, TransactionOption, Int32, Boolean) WebMethodAttribute(Boolean, TransactionOption, Int32, Boolean)

Propiedades

BufferResponse BufferResponse BufferResponse BufferResponse

Obtiene o establece si la respuesta para esta solicitud se almacena en el búfer.Gets or sets whether the response for this request is buffered.

CacheDuration CacheDuration CacheDuration CacheDuration

Obtiene o establece el número de segundos durante los cuales la respuesta se almacena en la caché.Gets or sets the number of seconds the response should be held in the cache.

Description Description Description Description

Mensaje descriptivo del método de servicios Web XML.A descriptive message describing the XML Web service method.

EnableSession EnableSession EnableSession EnableSession

Indica si se habilitó el estado de la sesión para un método de servicios Web XML.Indicates whether session state is enabled for an XML Web service method.

MessageName MessageName MessageName MessageName

Nombre que se utiliza para el método de servicios Web XML en los datos que se pasan a un método de servicios Web XML y que se devuelven desde éste.The name used for the XML Web service method in the data passed to and returned from an XML Web service method.

TransactionOption TransactionOption TransactionOption TransactionOption

Indica la compatibilidad con transacciones de un método de servicios Web XML.Indicates the transaction support of an XML Web service method.

TypeId TypeId TypeId TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Métodos

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Devuelve un valor que indica si esta instancia es igual que un objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Devuelve el código hash de esta instancia.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.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) Match(Object) Match(Object) Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Inherited from Object)

Implementaciones de interfaz explícitas

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.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) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).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) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Se aplica a

Consulte también: