SoapDocumentMethodAttribute.ResponseElementName Property

Reference

Definition

Namespace:: System.Web.Services.Protocols

Assembly:: System.Web.Services.dll

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 XML element associated with the SOAP response for an XML Web service method.

public:
 property System::String ^ ResponseElementName { System::String ^ get(); void set(System::String ^ value); };

public string ResponseElementName { get; set; }

member this.ResponseElementName : string with get, set

Public Property ResponseElementName As String

Property Value

String

The XML element associated with the SOAP request for an XML Web service method. The default value is WebServiceNameResult, where WebServiceName is the name of the XML Web service method.

Examples

The following code example sets the name of the XML element associated with the XML Web service method in the SOAP response to MyCustomResponseElement.

<%@ WebService Language="C#" Class="SoapDocumentMethodSample" %>
    
using System.Web.Services;
using System.Web.Services.Protocols;

public class SoapDocumentMethodSample
{
   [WebMethod]
   [SoapDocumentMethod(ResponseNamespace="http://www.contoso.com",ResponseElementName="MyCustomResponseElement")]
   public int[] ResponseDocument(int numentries)
   {
    int[] intarray = new int[numentries];
        for (int i=0;i<numentries;i++)
        {
       intarray[i] = i;
        }
        return intarray;
   }
}

<%@ WebService Language="VB" Class="SoapDocumentMethodSample" %>
    
Imports System.Web.Services
Imports System.Web.Services.Protocols

Public Class SoapDocumentMethodSample

   <WebMethod(),SoapDocumentMethod(ResponseNamespace :="http://www.contoso.com",ResponseElementName := "MyCustomResponseElement")> _
   Public Function  ResponseDocument(numentries as Integer) As Integer()
    Dim intarray(numentries - 1) as Integer
        Dim i as Integer
        For i = 0 To numentries - 1
           intarray(i) = i
        Next
        Return intarray
   End Function
End Class

Remarks

The ResponseElementName defines the XML element used to wrap the parameters beneath the Body element of the SOAP response when ParameterStyle is Wrapped. This is reflected in the XSD schema representing the SOAP response to the XML Web service method within the XML Web service's service description.

Applies to

Jaa