SoapDocumentMethodAttribute Klas

Definitie

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

Overname

Object

Attribute

SoapDocumentMethodAttribute

Kenmerken

AttributeUsageAttribute

Voorbeelden

In het volgende codevoorbeeld wordt de berichtstijl Document voor de GetUserName XML-webservicemethode ingesteld. Daarnaast wordt het XML-element met het Body element voor de SOAP-aanvraag en het SOAP-antwoord ingesteld GetUserNameRequest op respectievelijk GetUserNameResponse.

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

Opmerkingen

WSDL (Web Services Description Language) definieert twee stijlen voor de manier waarop een XML-webservicemethode, die een bewerking aanroept, kan worden opgemaakt in een SOAP-bericht: RPC en Document. Document verwijst naar het opmaken van de XML-webservicemethode volgens een XSD-schema. De Document stijl verwijst naar het opmaken van het Body element als een reeks van een of meer berichtonderdelen na het Body element. Precies hoe de afzonderlijke berichtonderdelen worden bepaald door de Use en ParameterStyle eigenschappen. De Use eigenschap bepaalt of parameters zijn opgemaakt Encoded of Literal. Hiermee ParameterStyle wordt bepaald of de parameters zijn ingekapseld binnen één berichtonderdeel na het Body element of dat elke parameter een afzonderlijk berichtonderdeel is.

Zie SOAP-berichtopmaak aanpassen voor meer informatie.

Dit kenmerk kan worden toegepast op zowel een XML-webservicemethode op de server als een methode van de proxyklasse op de client.

Zie ook

• SoapDocumentServiceAttribute
• SoapRpcMethodAttribute
• SoapRpcServiceAttribute
• SoapBindingUse
• SoapParameterStyle