Applying this attribute to an XML Web service client using HTTP-GET or HTTP-POST, sets the types that serialize the parameters sent to an XML Web service method and read the response from the XML Web service method. This class cannot be inherited.
System.Attribute
System.Web.Services.Protocols.HttpMethodAttribute
Namespace: System.Web.Services.Protocols
Assembly: System.Web.Services (in System.Web.Services.dll)
<AttributeUsageAttribute(AttributeTargets.Method)> _ Public NotInheritable Class HttpMethodAttribute _ Inherits Attribute
[AttributeUsageAttribute(AttributeTargets.Method)] public sealed class HttpMethodAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Method)] public ref class HttpMethodAttribute sealed : public Attribute
[<Sealed>] [<AttributeUsageAttribute(AttributeTargets.Method)>] type HttpMethodAttribute = class inherit Attribute end
The HttpMethodAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
|
HttpMethodAttribute() | Initializes a new instance of the HttpMethodAttribute class. |
|
HttpMethodAttribute(Type, Type) | Initializes a new instance of the HttpMethodAttribute. |
| Name | Description | |
|---|---|---|
|
ParameterFormatter | Gets or sets a Type that serializes parameters sent from an XML Web service client to the XML Web service method. |
|
ReturnFormatter | Gets or sets a Type that deserializes the response from an XML Web service method. |
|
TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
| 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 | |
|---|---|---|
|
_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.) |
If an XML Web service client calls an XML Web service method using HTTP-GET, ReturnFormatter must be set to XmlReturnReader and ParameterFormatter set to UrlParameterWriter. XML Web service clients invoking a XML Web service using HTTP-POST must set ReturnFormatter to XmlReturnReader and ParameterFormatter to HtmlFormParameterWriter.
The following example is a proxy class generated by the Wsdl.exe utility for calling an XML Web service utility using HTTP-POST. The Wsdl.exe automatically supplies the correct types for ReturnFormatter and ParameterFormatter, along with specifying that the proxy class inherits from HttpPostClientProtocol.
Public Class MyUser Inherits System.Web.Services.Protocols.HttpPostClientProtocol Public Sub New() Me.Url = "http://www.contoso.com/username.asmx" End Sub 'New <HttpMethodAttribute(GetType(XmlReturnReader), GetType(HtmlFormParameterWriter))> _ Public Function GetUserName() As UserName Return CType(Me.Invoke("GetUserName", Me.Url + "/GetUserName", New Object(0) {}), UserName) End Function 'GetUserName Public Function BeginGetUserName(callback As System.AsyncCallback, asyncState As Object) As System.IAsyncResult Return Me.BeginInvoke("GetUserName", Me.Url + "/GetUserName", New Object(0) {}, callback, asyncState) End Function 'BeginGetUserName Public Function EndGetUserName(asyncResult As System.IAsyncResult) As UserName Return CType(Me.EndInvoke(asyncResult), UserName) End Function 'EndGetUserName End Class 'MyUser <XmlRootAttribute(Namespace := "http://tempuri.org/", IsNullable := True)> _ Public Class UserName Public Name As String Public Domain As String End Class 'UserName
public class MyUser : System.Web.Services.Protocols.HttpPostClientProtocol { public MyUser() { this.Url = "http://www.contoso.com/username.asmx"; } [System.Web.Services.Protocols.HttpMethodAttribute(typeof(System.Web.Services.Protocols.XmlReturnReader), typeof(System.Web.Services.Protocols.HtmlFormParameterWriter))] public UserName GetUserName() { return ((UserName)(this.Invoke("GetUserName", (this.Url + "/GetUserName"), new object[0]))); } public System.IAsyncResult BeginGetUserName(System.AsyncCallback callback, object asyncState) { return this.BeginInvoke("GetUserName", (this.Url + "/GetUserName"), new object[0], callback, asyncState); } public UserName EndGetUserName(System.IAsyncResult asyncResult) { return ((UserName)(this.EndInvoke(asyncResult))); } } [System.Xml.Serialization.XmlRootAttribute(Namespace="http://tempuri.org/", IsNullable=true)] public class UserName { public string Name; public string Domain; }
[System::Xml::Serialization::XmlRootAttribute(Namespace="http://tempuri.org/",IsNullable=true)] public ref class UserName { public: String^ Name; String^ Domain; }; public ref class MyUser: public System::Web::Services::Protocols::HttpPostClientProtocol { public: MyUser() { this->Url = "http://www.contoso.com/username.asmx"; } [System::Web::Services::Protocols::HttpMethodAttribute(System::Web::Services::Protocols::XmlReturnReader::typeid,System::Web::Services::Protocols::HtmlFormParameterWriter::typeid)] UserName^ GetUserName() { return (dynamic_cast<UserName^>(this->Invoke( "GetUserName", (String::Concat( this->Url, "/GetUserName" )), gcnew array<Object^>(0) ))); } System::IAsyncResult^ BeginGetUserName( System::AsyncCallback^ callback, Object^ asyncState ) { return this->BeginInvoke( "GetUserName", (String::Concat( this->Url, "/GetUserName" )), gcnew array<Object^>(0), callback, asyncState ); } UserName^ EndGetUserName( System::IAsyncResult^ asyncResult ) { return (dynamic_cast<UserName^>(this->EndInvoke( asyncResult ))); } };
.NET Framework
Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0.NET Framework Client Profile
Supported in: 4, 3.5 SP1Windows 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.