SoapMethodAttribute Class
Customizes SOAP generation and processing for a method. This class cannot be inherited.
System::Attribute
System.Runtime.Remoting.Metadata::SoapAttribute
System.Runtime.Remoting.Metadata::SoapMethodAttribute
Assembly: mscorlib (in mscorlib.dll)
The SoapMethodAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | Embedded | Gets or sets a value indicating whether the type must be nested during SOAP serialization. (Inherited from SoapAttribute.) |
![]() | ResponseXmlElementName | Gets or sets the XML element name to use for the method response to the target method. |
![]() | ResponseXmlNamespace | Gets or sets the XML element namesapce used for method response to the target method. |
![]() | ReturnXmlElementName | Gets or sets the XML element name used for the return value from the target method. |
![]() | SoapAction | Gets or sets the SOAPAction header field used with HTTP requests sent with this method. This property is currently not implemented. |
![]() | TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
![]() | UseAttribute | Gets or sets a value indicating whether the target of the current attribute will be serialized as an XML attribute instead of an XML field. (Overrides SoapAttribute::UseAttribute.) |
![]() | XmlNamespace | Gets or sets the XML namespace that is used during serialization of remote method calls of the target method. (Overrides SoapAttribute::XmlNamespace.) |
| Name | Description | |
|---|---|---|
![]() | Equals | Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | IsDefaultAttribute | When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.) |
![]() | Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() | ProtXmlNamespace | Infrastructure. The XML namespace to which the target of the current SOAP attribute is serialized. (Inherited from SoapAttribute.) |
![]() | ReflectInfo | Infrastructure. A reflection object used by attribute classes derived from the SoapAttribute class to set XML serialization information. (Inherited from SoapAttribute.) |
| Name | Description | |
|---|---|---|
![]() ![]() | _Attribute::GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) |
![]() ![]() | _Attribute::GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) |
![]() ![]() | _Attribute::GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) |
![]() ![]() | _Attribute::Invoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
The target objects for the SoapMethodAttribute attribute are methods that can be remotely invoked. Apply the SoapMethodAttribute to customize SOAP generation and processing. Properties of this attribute allow the programmer to customize the SOAPAction HTTP header field to indicate the intent of the SOAP HTTP request.
The following code example shows how to use the members in the SoapMethodAttribute class to customize SOAP generation and processing for a method.
#using <System.dll> #using <System.Runtime.Remoting.dll> using namespace System; using namespace System::Runtime::Remoting::Metadata; namespace ExampleNamespace { public ref class ExampleClass { public: [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 ); } }; } int main() { // Get the method info object for the GetHello method. System::Reflection::MethodBase^ getHelloMethod = ExampleNamespace::ExampleClass::typeid->GetMethod( L"GetHello" ); // Print the XML namespace for the invocation of this method. String^ methodCallXmlNamespace = System::Runtime::Remoting::SoapServices::GetXmlNamespaceForMethodCall( getHelloMethod ); Console::WriteLine( L"The XML namespace for the response of the method " L"GetHello in ExampleClass is {0}.", methodCallXmlNamespace ); // Print the XML namespace for the response of this method. String^ methodResponseXmlNamespace = System::Runtime::Remoting::SoapServices::GetXmlNamespaceForMethodCall( getHelloMethod ); Console::WriteLine( L"The XML namespace for the invocation of the method " L"GetHello in ExampleClass is {0}.", methodResponseXmlNamespace ); // Print the SOAP action for this method. String^ getHelloSoapAction = System::Runtime::Remoting::SoapServices::GetXmlNamespaceForMethodCall( getHelloMethod ); Console::WriteLine( L"The SOAP action for the method " L"GetHello in ExampleClass is {0}.", getHelloSoapAction ); }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
