SoapDocumentMethodAttribute Classe
Définition
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.
L’application de la SoapDocumentMethodAttribute à une méthode spécifie que les messages SOAP vers et à partir de la méthode utilisent Document mise en forme.
public ref class SoapDocumentMethodAttribute sealed : Attribute[System.AttributeUsage(System.AttributeTargets.Method)]
public sealed class SoapDocumentMethodAttribute : Attribute[<System.AttributeUsage(System.AttributeTargets.Method)>]
type SoapDocumentMethodAttribute = class
inherit AttributePublic NotInheritable Class SoapDocumentMethodAttribute
Inherits Attribute- Héritage
- Attributs
Exemples
L’exemple de code suivant définit le style Document de message pour la méthode de GetUserName service Web XML. En outre, l’élément XML avec l’élément Body pour la requête SOAP et la réponse SOAP sont définis GetUserNameRequest sur et GetUserNameResponse, respectivement.
<%@ WebService Language="C#" class="MyUser" %>
using System;
using System.Web.Services;
using System.Web.Services.Protocols;
public class MyUser : WebService {
[ SoapDocumentMethod(Action="http://www.contoso.com/Sample",
RequestNamespace="http://www.contoso.com/Request",
RequestElementName="GetUserNameRequest",
ResponseNamespace="http://www.contoso.com/Response",
ResponseElementName="GetUserNameResponse")]
[ WebMethod(Description="Obtains the User Name") ]
public UserName GetUserName() {
string temp;
int pos;
UserName NewUser = new UserName();
// Get the full user name, including the domain name if applicable.
temp = User.Identity.Name;
// Determine whether the user is part of a domain by searching for a backslash.
pos = temp.IndexOf("\\");
// Parse the domain name out of the string, if one exists.
if (pos <= 0)
NewUser.Name = User.Identity.Name;
else {
NewUser.Name = temp.Remove(0,pos+1);
NewUser.Domain = temp.Remove(pos,temp.Length-pos);
}
return NewUser;
}
}
public class UserName {
public string Name;
public string Domain;
}
<%@ WebService Language="VB" class="MyUser" %>
Imports System
Imports System.Web.Services
Imports System.Web.Services.Protocols
Public Class MyUser
Inherits WebService
<SoapDocumentMethod(Action := "http://www.contoso.com/Sample", _
RequestNamespace := "http://www.contoso.com/Request", _
RequestElementName := "GetUserNameRequest", _
ResponseNamespace := "http://www.contoso.com/Response", _
ResponseElementName := "GetUserNameResponse"), _
WebMethod(Description := "Obtains the User Name")> _
Public Function GetUserName() As UserName
Dim temp As String
Dim pos As Integer
Dim NewUser As New UserName()
' Get the full user name, including the domain name if applicable.
temp = User.Identity.Name
' Determine whether the user is part of a Domain by searching for a backslash.
pos = temp.IndexOf("\")
' Parse the domain name out of the string, if one exists.
If pos <= 0 Then
NewUser.Name = User.Identity.Name
Else
NewUser.Name = temp.Remove(0, pos + 1)
NewUser.Domain = temp.Remove(pos, temp.Length - pos)
End If
Return NewUser
End Function
End Class
Public Class UserName
Public Name As String
Public Domain As String
End Class
Remarques
Web Services Description Language (WSDL) définit deux styles pour la façon dont une méthode de service Web XML, qu’elle appelle une opération, peut être mise en forme dans un message SOAP : RPC et Document.
Document fait référence à la mise en forme de la méthode de service Web XML en fonction d’un schéma XSD. Le Document style fait référence à la mise en forme de l’élément Body en tant que série d’une ou plusieurs parties de message qui suivent l’élément Body . Comment les parties de message individuelles sont déterminées par les propriétés et ParameterStyle les Use propriétés. La Use propriété détermine si les paramètres sont mis en forme Encoded ou Literal. Détermine ParameterStyle si les paramètres sont encapsulés dans une partie de message unique suivant l’élément Body ou si chaque paramètre est une partie de message individuelle.
Pour plus d’informations, consultez Personnalisation de la mise en forme des messages SOAP.
Cet attribut peut être appliqué à la fois à une méthode de service Web XML sur le serveur et à une méthode de la classe proxy sur le client.
Constructeurs
| Nom | Description |
|---|---|
| SoapDocumentMethodAttribute() |
Initialise une nouvelle instance de la classe SoapDocumentMethodAttribute. |
| SoapDocumentMethodAttribute(String) |
Initialise une nouvelle instance de la SoapDocumentMethodAttribute classe, en définissant la Action propriété sur la valeur du |
Propriétés
| Nom | Description |
|---|---|
| Action |
Obtient ou définit le |
| Binding |
Obtient ou définit la liaison pour laquelle une méthode de service web XML implémente une opération. |
| OneWay |
Obtient ou définit si un client de service web XML attend que le serveur Web termine le traitement d’une méthode de service Web XML. |
| ParameterStyle |
Obtient ou définit si les paramètres sont encapsulés dans un seul élément XML sous l’élément |
| RequestElementName |
Obtient ou définit l’élément XML associé à la requête SOAP pour une méthode de service Web XML, qui est définie dans une description de service en tant qu’opération. |
| RequestNamespace |
Obtient ou définit l’espace de noms associé à la requête SOAP pour une méthode de service web XML. |
| ResponseElementName |
Obtient ou définit l’élément XML associé à la réponse SOAP pour une méthode de service web XML. |
| ResponseNamespace |
Obtient ou définit l’espace de noms XML associé à la réponse SOAP pour 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) |
| Use |
Obtient ou définit la mise en forme des paramètres d’une méthode de service Web XML dans la partie XML d’un message SOAP. |
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) |
