SoapMethodAttribute Класс

Определение

Пространство имен:

System.Runtime.Remoting.Metadata

Сборка:

mscorlib.dll

Настраивает создание и обработку SOAP для метода. Этот класс не наследуется.

public ref class SoapMethodAttribute sealed : System::Runtime::Remoting::Metadata::SoapAttribute

[System.AttributeUsage(System.AttributeTargets.Method)]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class SoapMethodAttribute : System.Runtime.Remoting.Metadata.SoapAttribute

[<System.AttributeUsage(System.AttributeTargets.Method)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type SoapMethodAttribute = class
    inherit SoapAttribute

Public NotInheritable Class SoapMethodAttribute
Inherits SoapAttribute

Наследование

Object

Attribute

SoapAttribute

SoapMethodAttribute

Атрибуты

AttributeUsageAttribute ComVisibleAttribute

Примеры

В следующем примере кода показано, как использовать члены класса SoapMethodAttribute для настройки создания и обработки SOAP для метода.

#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 );
}

using System;
using System.Runtime.Remoting.Metadata;

namespace ExampleNamespace
{
    public class ExampleClass
    {
        [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;
        }
    }
}

public class Demo
{
    public static void Main(string[] args)
    {
        // Get the method info object for the GetHello method.
        System.Reflection.MethodBase getHelloMethod =
            typeof(ExampleNamespace.ExampleClass).GetMethod("GetHello");

        // Print the XML namespace for the invocation of this method.
        string methodCallXmlNamespace =
            System.Runtime.Remoting.SoapServices.
                GetXmlNamespaceForMethodCall(getHelloMethod);
        Console.WriteLine(
            "The XML namespace for the response of the method " +
            "GetHello in ExampleClass is {0}.",
            methodCallXmlNamespace);

        // Print the XML namespace for the response of this method.
        string methodResponseXmlNamespace =
            System.Runtime.Remoting.SoapServices.
                GetXmlNamespaceForMethodResponse(getHelloMethod);
        Console.WriteLine(
            "The XML namespace for the invocation of the method " +
            "GetHello in ExampleClass is {0}.",
            methodResponseXmlNamespace);

        // Print the SOAP action for this method.
        string getHelloSoapAction =
            System.Runtime.Remoting.SoapServices.
                GetSoapActionFromMethodBase(getHelloMethod);
        Console.WriteLine(
            "The SOAP action for the method " +
            "GetHello in ExampleClass is {0}.",
            getHelloSoapAction);
    }
}

Комментарии

Целевые объекты для атрибута SoapMethodAttribute — это методы, которые можно удаленно вызывать. Примените к настройке SoapMethodAttribute создания и обработки SOAP. Свойства этого атрибута позволяют программисту настроить поле заголовка SOAPAction HTTP, чтобы указать намерение HTTP-запроса SOAP.

Конструкторы

Имя	Описание
SoapMethodAttribute()	Создает экземпляр .SoapMethodAttribute

Поля

Имя	Описание
ProtXmlNamespace	Пространство имен XML, в которое сериализуется целевой объект текущего атрибута SOAP. (Унаследовано от SoapAttribute)
ReflectInfo	Объект отражения, используемый классами атрибутов, производными от SoapAttribute класса, для задания сведений о сериализации XML. (Унаследовано от SoapAttribute)

Свойства

Имя	Описание
Embedded	Возвращает или задает значение, указывающее, должен ли тип быть вложен во время сериализации SOAP. (Унаследовано от SoapAttribute)
ResponseXmlElementName	Возвращает или задает имя XML-элемента, используемое для ответа метода на целевой метод.
ResponseXmlNamespace	Возвращает или задает пространство имен XML-элемента, используемое для ответа метода на целевой метод.
ReturnXmlElementName	Возвращает или задает имя XML-элемента, используемое для возвращаемого значения из целевого метода.
SoapAction	Возвращает или задает поле заголовка SOAPAction, используемое с HTTP-запросами, отправленными с помощью этого метода. Это свойство в настоящее время не реализовано.
TypeId	При реализации в производном классе получает уникальный идентификатор для этого Attribute. (Унаследовано от Attribute)
UseAttribute	Возвращает или задает значение, указывающее, сериализуется ли целевой объект текущего атрибута в виде XML-атрибута вместо поля XML.
XmlNamespace	Возвращает или задает пространство имен XML, используемое во время сериализации вызовов удаленных методов целевого метода.

Методы

Имя	Описание
Equals(Object)	Возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute)
GetHashCode()	Возвращает хэш-код для этого экземпляра. (Унаследовано от Attribute)
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
IsDefaultAttribute()	При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса. (Унаследовано от Attribute)
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

Явные реализации интерфейса

Имя	Описание
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации. (Унаследовано от Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Извлекает сведения о типе объекта, который можно использовать для получения сведений о типе для интерфейса. (Унаследовано от Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1). (Унаследовано от Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Предоставляет доступ к свойствам и методам, предоставляемым объектом. (Унаследовано от Attribute)