SoapDocumentMethodAttribute.Use Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the parameter formatting for an XML Web service method within the XML portion of a SOAP message.
public:
property System::Web::Services::Description::SoapBindingUse Use { System::Web::Services::Description::SoapBindingUse get(); void set(System::Web::Services::Description::SoapBindingUse value); };
public System.Web.Services.Description.SoapBindingUse Use { get; set; }
member this.Use : System.Web.Services.Description.SoapBindingUse with get, set
Public Property Use As SoapBindingUse
Property Value
The SoapBindingUse for the XML Web service method. The default is Literal.
Examples
The following code example specifies that Document
/ Encoded
SOAP messages must be sent to the PlaceOrder
XML Web service method.
<%@ WebService Language="C#" Class="ShoppingCart" %>
using System.Web.Services;
using System.Web.Services.Protocols;
using System.Web.Services.Description;
using System;
public class ShoppingCart
{
[ SoapDocumentMethod(Use=SoapBindingUse.Encoded) ]
[ WebMethod]
public void PlaceOrder(OrderItem O)
{
// Process the order on the back end.
}
}
public class OrderItem
{
public int Count;
public int Description;
public DateTime OrderDate;
public long CustomerID;
public Decimal Cost;
}
<%@ WebService Language="VB" Class="ShoppingCart" %>
Imports System.Web.Services
Imports System.Web.Services.Protocols
Imports System.Web.Services.Description
Imports System
Public Class ShoppingCart
' Specify that the XML Web service method uses encoded SOAP messages.
<SoapDocumentMethod(Use:=SoapBindingUse.Encoded), _
WebMethod()> _
Public Sub PlaceOrder(O as OrderItem)
' Process the order on the back end.
End Sub
End Class
Public Class OrderItem
Public Count As Integer
Public Description as String
Public OrderDate as DateTime
Public CustomerID as Long
Public Cost as Decimal
End Class
Remarks
The Web Services Description Language (WSDL) defines two methods for formatting parameters: Encoded and Literal. Encoded refers to formatting parameters using SOAP encoding, as outlined in the SOAP specification in section 5. Literal refers to formatting the parameters using a pre-defined XSD schema for each parameter.
For more details, see Customizing SOAP Message Formatting.