WebMethodAttribute Classe

Definição

Adicionar esse atributo a um método em um serviço Web XML criado usando ASP.NET torna o método chamável de clientes remotos da Web.Adding this attribute to a method within an XML Web service created using ASP.NET makes the method callable from remote Web clients. Essa classe não pode ser herdada.This class cannot be inherited.

public ref class WebMethodAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Method)]
public sealed class WebMethodAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Method, Inherited=true)]
public sealed class WebMethodAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Method)>]
type WebMethodAttribute = class
    inherit Attribute
[<System.AttributeUsage(System.AttributeTargets.Method, Inherited=true)>]
type WebMethodAttribute = class
    inherit Attribute
Public NotInheritable Class WebMethodAttribute
Inherits Attribute
Herança
WebMethodAttribute
Atributos

Exemplos

No exemplo abaixo, o método GetMachineName pode ser chamado remotamente pela Web, porque ele tem um WebMethodAttribute .In the example below the method GetMachineName can be remotely called across the Web, because it has a WebMethodAttribute. GetUserName Não pode ser chamado remotamente, pois não tem um WebMethodAttribute , embora seja public .GetUserName 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

Comentários

Os métodos dentro de uma classe que têm esse atributo definido são chamados de métodos de serviço Web XML.Methods within a class that have this attribute set are called XML Web service methods. O método e a classe devem ser públicos e em execução dentro de um aplicativo Web ASP.NET.The method and class must be public and running inside an ASP.NET Web application.

Construtores

WebMethodAttribute()

Inicializa uma nova instância da classe WebMethodAttribute.Initializes a new instance of the WebMethodAttribute class.

WebMethodAttribute(Boolean)

Inicializa uma nova instância da classe WebMethodAttribute.Initializes a new instance of the WebMethodAttribute class.

WebMethodAttribute(Boolean, TransactionOption)

Inicializa uma nova instância da classe WebMethodAttribute.Initializes a new instance of the WebMethodAttribute class.

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

Inicializa uma nova instância da classe WebMethodAttribute.Initializes a new instance of the WebMethodAttribute class.

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

Inicializa uma nova instância da classe WebMethodAttribute.Initializes a new instance of the WebMethodAttribute class.

WebMethodAttribute(Boolean, TransactionOption, Int32, Boolean)

Propriedades

BufferResponse

Obtém ou define se a resposta para essa solicitação é armazenada em buffer.Gets or sets whether the response for this request is buffered.

CacheDuration

Obtém ou define o número de segundos que a resposta deve ser mantida no cache.Gets or sets the number of seconds the response should be held in the cache.

Description

Uma mensagem descritiva que descreve o método de serviço Web XML.A descriptive message describing the XML Web service method.

EnableSession

Indica se o estado de sessão é habilitado para um método de serviço Web XML.Indicates whether session state is enabled for an XML Web service method.

MessageName

O nome usado para o método de serviço Web XML nos dados passados e retornados de um método de serviço Web XML.The name used for the XML Web service method in the data passed to and returned from an XML Web service method.

TransactionOption

Indica o suporte a transações de um método de serviço Web XML.Indicates the transaction support of an XML Web service method.

TypeId

Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Herdado de Attribute)

Métodos

Equals(Object)

Retorna um valor que indica se essa instância é igual a um objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Herdado de Attribute)
GetHashCode()

Retorna o código hash para a instância.Returns the hash code for this instance.

(Herdado de Attribute)
GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
IsDefaultAttribute()

Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Herdado de Attribute)
Match(Object)

Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Herdado de Attribute)
MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)

Implantações explícitas de interface

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

Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expedição.Maps a set of names to a corresponding set of dispatch identifiers.

(Herdado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Recupera as informações de tipo para um objeto, que pode ser usado para obter as informações de tipo para uma interface.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Herdado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Herdado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fornece acesso a propriedades e métodos expostos por um objeto.Provides access to properties and methods exposed by an object.

(Herdado de Attribute)

Aplica-se a

Confira também