WebMethodAttribute Classe

Définition

Espace de noms:

System.Web.Services

Assembly:

System.Web.Services.dll

L’ajout de cet attribut à une méthode au sein d’un service Web XML créé à l’aide de ASP.NET rend la méthode appelante à partir de clients Web distants. Cette classe ne peut pas être héritée.

public ref class WebMethodAttribute sealed : Attribute

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

[<System.AttributeUsage(System.AttributeTargets.Method)>]
type WebMethodAttribute = class
    inherit Attribute

Public NotInheritable Class WebMethodAttribute
Inherits Attribute

Héritage

Object

Attribute

WebMethodAttribute

Attributs

AttributeUsageAttribute

Exemples

Dans l’exemple ci-dessous, la méthode GetMachineName peut être appelée à distance sur le web, car elle a un WebMethodAttribute. GetUserName ne peut pas être appelé à distance, car il n’a pas , WebMethodAttributemême s’il est 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

Remarques

Les méthodes d’une classe qui ont ce jeu d’attributs sont appelées méthodes de service web XML. La méthode et la classe doivent être publiques et exécutées à l’intérieur d’une application web ASP.NET.

Constructeurs

Nom	Description
WebMethodAttribute()	Initialise une nouvelle instance de la classe WebMethodAttribute.
WebMethodAttribute(Boolean, TransactionOption, Int32, Boolean)	Initialise une nouvelle instance de la classe WebMethodAttribute.
WebMethodAttribute(Boolean, TransactionOption, Int32)	Initialise une nouvelle instance de la classe WebMethodAttribute.
WebMethodAttribute(Boolean, TransactionOption)	Initialise une nouvelle instance de la classe WebMethodAttribute.
WebMethodAttribute(Boolean)	Initialise une nouvelle instance de la classe WebMethodAttribute.

Propriétés

Nom	Description
BufferResponse	Obtient ou définit si la réponse de cette requête est mise en mémoire tampon.
CacheDuration	Obtient ou définit le nombre de secondes pendant lesquelles la réponse doit être conservée dans le cache.
Description	Message descriptif décrivant la méthode de service Web XML.
EnableSession	Indique si l’état de session est activé pour une méthode de service web XML.
MessageName	Nom utilisé pour la méthode de service Web XML dans les données transmises et retournées à partir d’une méthode de service Web XML.
TransactionOption	Indique la prise en charge des transactions d’une méthode de service Web XML.
TypeId	En cas d’implémentation dans une classe dérivée, obtient un identificateur unique pour cette Attribute. (Hérité de Attribute)

Méthodes

Nom	Description
Equals(Object)	Retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute)
GetHashCode()	Retourne le code de hachage pour cette instance. (Hérité de Attribute)
GetType()	Obtient la Type de l’instance actuelle. (Hérité de Object)
IsDefaultAttribute()	En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut de la classe dérivée. (Hérité de Attribute)
Match(Object)	En cas de substitution dans une classe dérivée, retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute)
MemberwiseClone()	Crée une copie superficielle du Objectactuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l’objet actuel. (Hérité de Object)

Implémentations d’interfaces explicites

Nom	Description
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch. (Hérité de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Récupère les informations de type d’un objet, qui peuvent être utilisées pour obtenir les informations de type d’une interface. (Hérité de Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1). (Hérité de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Fournit l’accès aux propriétés et méthodes exposées par un objet. (Hérité de Attribute)

Voir aussi

• TransactionOption
• WebService