SoapDocumentMethodAttribute Classe

Definição

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 Attribute

Public NotInheritable Class SoapDocumentMethodAttribute
Inherits Attribute

Herança

Object

Attribute

SoapDocumentMethodAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo de código a seguir define o estilo de mensagem para Document o método de GetUserName serviço Web XML. Além disso, o elemento XML com o Body elemento para a solicitação SOAP e a resposta SOAP são definidos como GetUserNameRequest e GetUserNameResponse, respectivamente.

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

Comentários

A Linguagem de Descrição dos Serviços Web (WSDL) define dois estilos de como um método de serviço Web XML, que ele chama de operação, pode ser formatado em uma mensagem SOAP: RPC e Document. Document refere-se à formatação do método de serviço Web XML de acordo com um esquema XSD. O Document estilo refere-se à formatação do Body elemento como uma série de uma ou mais partes de mensagem seguindo o Body elemento. Exatamente como as partes de mensagem individuais são determinadas pelas propriedades e ParameterStyle pelas Use propriedades. A Use propriedade determina se os parâmetros são formatados Encoded ou Literal. Determina ParameterStyle se os parâmetros são encapsulados em uma única parte da mensagem após o Body elemento ou se cada parâmetro é uma parte de mensagem individual.

Para obter mais detalhes, consulte Personalizando a formatação de mensagens SOAP.

Esse atributo pode ser aplicado a um método de serviço Web XML no servidor e a um método da classe proxy no cliente.

Confira também

• SoapDocumentServiceAttribute
• SoapRpcMethodAttribute
• SoapRpcServiceAttribute
• SoapBindingUse
• SoapParameterStyle