SoapHeaderAttribute Classe

Définition

Espace de noms:: System.Web.Services.Protocols

Assembly:: System.Web.Services.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Cet attribut est appliqué à une méthode de service Web XML ou à un client de service Web XML pour spécifier un en-tête SOAP que la méthode de service Web XML ou le client de service web XML peut traiter. Cette classe ne peut pas être héritée.

public ref class SoapHeaderAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=true)]
public sealed class SoapHeaderAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=true)>]
type SoapHeaderAttribute = class
    inherit Attribute

Public NotInheritable Class SoapHeaderAttribute
Inherits Attribute

Héritage: Object

Attribute
SoapHeaderAttribute

Attributs: AttributeUsageAttribute

Exemples

Le service web XML suivant MyWebService définit l’un SoapHeader des types MyHeader. La Hello méthode de service web XML exige que le client appelle la méthode de service Web XML avec ce SoapHeaderparamètre . Le Hello service Web XML intercepte également tous les en-têtes SOAP autres que MyHeader.

<%@ WebService Language="C#" Class="MyWebService"%>
using System.Web.Services;
using System.Web.Services.Protocols;

// Define a SOAP header by deriving from the SoapHeader base class.
// The header contains just one string value.
public class MyHeader : SoapHeader {
    public string MyValue;
}

public class MyWebService {
    // Member variable to receive the contents of the MyHeader SoapHeader.
    public MyHeader myHeader;

    // Member variable to receive all headers other than MyHeader.
    public SoapUnknownHeader[] unknownHeaders;
 
    [WebMethod]
    [SoapHeader("myHeader", Direction=SoapHeaderDirection.InOut)]

    // Receive any SOAP headers other than MyHeader.
    [SoapHeader("unknownHeaders")]
    public void Hello() {

       // Process the MyHeader SoapHeader.
       if (myHeader.MyValue == "Some string") {
          // Process the header.
       }
       foreach (SoapHeader header in unknownHeaders) {
           // Perform some processing on header.
           
           // For those headers that cannot be processed,
           // set the DidUnderstand property to false.
           header.DidUnderstand = false;
       }
    }
}

<%@ WebService Language="VB" Class="MyWebService"%>
Imports System.Web.Services
Imports System.Web.Services.Protocols

' Define a SOAP header by deriving from the SoapHeader base class.
' The header contains just one string value.
Public Class MyHeader
    Inherits SoapHeader
    Public MyValue As String
End Class

Public Class MyWebService
    ' Member variable to receive the contents of the MyHeader SoapHeader.
    Public myHeader As MyHeader
    
    ' Member variable to receive all headers other than MyHeader.
    Public unknownHeaders() As SoapUnknownHeader
    
    ' Receive any SOAP headers other than MyHeader.
    <WebMethod, _
        SoapHeader("myHeader", Direction := SoapHeaderDirection.InOut), _
        SoapHeader("unknownHeaders")> _
    Public Sub Hello()        
        
        ' Process the MyHeader SoapHeader.
        If myHeader.MyValue = "Some string" Then
            ' Process the header.
        End If 
        Dim header As SoapHeader
        For Each header In  unknownHeaders
            ' Perform some processing on header
            ' For those headers that cannot be processed, 
            ' set the DidUnderstand to false.
            header.DidUnderstand = False
        Next header
    End Sub
End Class

Remarques

Les étapes de base pour recevoir et traiter un en-tête SOAP sont les suivantes :

Créez une classe dérivant de SoapHeader la représentation des données transmises dans l’en-tête SOAP.
Ajoutez un membre à la classe de service Web XML ou à la classe proxy du client de service web XML du type créé à l’étape 1.
Appliquez une SoapHeaderAttribute méthode de service Web XML ou la méthode correspondante dans la classe proxy, en spécifiant le membre créé à l’étape 2 de la MemberName propriété.
Au sein de la méthode de service Web XML ou du code client du service Web XML, accédez à la MemberName propriété pour traiter les données envoyées dans l’en-tête SOAP.

Pour plus d’informations, consultez la MemberName propriété.

Constructeurs

Nom	Description
SoapHeaderAttribute(String)	Initialise une nouvelle instance de la SoapHeaderAttribute classe, en définissant le membre de la classe de service Web XML représentant le contenu de l’en-tête SOAP.

Propriétés

Nom	Description
Direction	Obtient ou définit si l’en-tête SOAP est destiné au service Web XML ou au client de service web XML ou aux deux.
MemberName	Obtient ou définit le membre de la classe de service Web XML représentant le contenu de l’en-tête SOAP.
Required	Obsolète. Ce membre est obsolète et n’a aucune fonctionnalité.
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)

S’applique à

Voir aussi

Commentaires

Cette page a-t-elle été utile ?