SoapDocumentMethodAttribute Sınıf

Başvuru

Tanım

Ad Alanı:: System.Web.Services.Protocols

Bütünleştirilmiş Kod:: System.Web.Services.dll

Önemli

Bazı bilgiler ürünün ön sürümüyle ilgilidir ve sürüm öncesinde önemli değişiklikler yapılmış olabilir. Burada verilen bilgilerle ilgili olarak Microsoft açık veya zımni hiçbir garanti vermez.

SoapDocumentMethodAttribute bir yönteme uygulandığında, yöntemine ve yönteminden SOAP iletilerinin biçimlendirme kullandığını Document belirtir.

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

Devralma: Object

Attribute
SoapDocumentMethodAttribute

Öznitelikler: AttributeUsageAttribute

Örnekler

Aşağıdaki kod örneği, XML Web hizmeti yöntemi için GetUserName ileti stilini olarak Document ayarlar. Ayrıca, SOAP isteği ve SOAP yanıtı için öğesini içeren XML öğesi Body sırasıyla ve GetUserNameResponseolarak ayarlanırGetUserNameRequest.

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

Açıklamalar

Web Hizmetleri Açıklama Dili (WSDL), bir işlemi çağırdığı XML Web hizmeti yönteminin soap iletisinde nasıl biçimlendirilebileceğine ilişkin iki stil tanımlar: RPC ve Document. Document XML Web hizmeti yöntemini bir XSD şemasına göre biçimlendirmeyi ifade eder. Stil, Document öğeyi, öğeyi Body izleyen bir veya daha fazla ileti parçası dizisi olarak biçimlendirmeyi Body ifade eder. Tek tek ileti bölümlerinin ve ParameterStyle özellikleri tarafından Use tam olarak nasıl belirlendiği. Use özelliği parametrelerin biçimlendirilip biçimlendirilmeyeceğini Encoded belirler.Literal , ParameterStyle parametrelerin öğeyi izleyen tek bir ileti parçası içinde kapsüllenip kapsüllenmeyeceğini veya her parametrenin Body tek bir ileti parçası olup olmadığını belirler.

Diğer ayrıntılar için bkz. SOAP İleti Biçimlendirmesini Özelleştirme.

Bu öznitelik hem sunucudaki bir XML Web hizmeti yöntemine hem de istemcideki proxy sınıfının yöntemine uygulanabilir.

Oluşturucular

SoapDocumentMethodAttribute()	SoapDocumentMethodAttribute sınıfının yeni bir örneğini başlatır.
SoapDocumentMethodAttribute(String)	özelliğini parametresinin SoapDocumentMethodAttribute değerine `action` ayarlayarak Action sınıfının yeni bir örneğini başlatır.

Özellikler

Action	SOAP isteğinin `SOAPAction` HTTP üst bilgi alanını alır veya ayarlar.
Binding	XML Web hizmeti yönteminin bir işlemi uyguladığı bağlamayı alır veya ayarlar.
OneWay	XML Web hizmeti istemcisinin Web sunucusunun XML Web hizmeti yöntemini işlemeyi tamamlayıp bitirmemesini bekleyip beklemediğini alır veya ayarlar.
ParameterStyle	Parametrelerin SOAP iletisinin XML bölümündeki öğesinin altındaki `Body` tek bir XML öğesi içinde kapsüllenip kapsüllenmeyeceğini alır veya ayarlar.
RequestElementName	Hizmet açıklamasında bir işlem olarak tanımlanan XML Web hizmeti yöntemi için SOAP isteğiyle ilişkili XML öğesini alır veya ayarlar.
RequestNamespace	BIR XML Web hizmeti yöntemi için SOAP isteğiyle ilişkili ad alanını alır veya ayarlar.
ResponseElementName	BIR XML Web hizmeti yöntemi için SOAP yanıtıyla ilişkili XML öğesini alır veya ayarlar.
ResponseNamespace	BIR XML Web hizmeti yöntemi için SOAP yanıtıyla ilişkili XML ad alanını alır veya ayarlar.
TypeId	Türetilmiş bir sınıfta uygulandığında, bu Attributeiçin benzersiz bir tanımlayıcı alır. (Devralındığı yer: Attribute)
Use	BIR SOAP iletisinin XML bölümünde xml web hizmeti yöntemi için parametre biçimlendirmesini alır veya ayarlar.

Yöntemler

Equals(Object)	Bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değeri döndürür. (Devralındığı yer: Attribute)
GetHashCode()	Bu örneğe ilişkin karma kodu döndürür. (Devralındığı yer: Attribute)
GetType()	Type Geçerli örneğini alır. (Devralındığı yer: Object)
IsDefaultAttribute()	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin değerinin türetilmiş sınıf için varsayılan değer olup olmadığını gösterir. (Devralındığı yer: Attribute)
Match(Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin belirtilen bir nesneye eşit olup olmadığını belirten bir değer döndürür. (Devralındığı yer: Attribute)
MemberwiseClone()	Geçerli Objectöğesinin sığ bir kopyasını oluşturur. (Devralındığı yer: Object)
ToString()	Geçerli nesneyi temsil eden dizeyi döndürür. (Devralındığı yer: Object)

Belirtik Arabirim Kullanımları

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Bir ad kümesini karşılık gelen bir dağıtma tanımlayıcısı kümesine eşler. (Devralındığı yer: Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Bir arabirimin tür bilgilerini almak için kullanılabilecek bir nesnenin tür bilgilerini alır. (Devralındığı yer: Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Bir nesnenin sağladığı tür bilgisi arabirimlerinin sayısını alır (0 ya da 1). (Devralındığı yer: Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Bir nesne tarafından sunulan özelliklere ve yöntemlere erişim sağlar. (Devralındığı yer: Attribute)

Şunlara uygulanır