SoapMethodAttribute.ReturnXmlElementName Property

Reference

Definition

Namespace:: System.Runtime.Remoting.Metadata

Assembly:: mscorlib.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 name used for the return value from the target method.

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

public string ReturnXmlElementName { get; set; }

member this.ReturnXmlElementName : string with get, set

Public Property ReturnXmlElementName As String

Property Value

String

The XML element name used for the return value from the target method.

Examples

The following code example shows how to use the ReturnXmlElementName property. This code example is part of a larger example provided for the SoapMethodAttribute class.

[SoapMethod(
   ResponseXmlElementName="ExampleResponseElement",
   ResponseXmlNamespace=
   "http://example.org/MethodResponseXmlNamespace",
   ReturnXmlElementName="HelloMessage",
   SoapAction="http://example.org/ExampleSoapAction#GetHello",
   XmlNamespace="http://example.org/MethodCallXmlNamespace")]
String^ GetHello( String^ name )
{
   return String::Format( L"Hello, {0}", name );
}

[SoapMethod(
     ResponseXmlElementName="ExampleResponseElement",
     ResponseXmlNamespace=
        "http://example.org/MethodResponseXmlNamespace",
     ReturnXmlElementName="HelloMessage",
     SoapAction="http://example.org/ExampleSoapAction#GetHello",
     XmlNamespace="http://example.org/MethodCallXmlNamespace")]
public string GetHello(string name)
{
    return "Hello, " + name;
}

Remarks

The default value of this property is the "__return" string.

Applies to

Product	Versions
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via