SoapRpcServiceAttribute Class (System.Web.Services.Protocols)

Switch View :

ScriptFree

.NET Framework Class Library

SoapRpcServiceAttribute Class

Sets the default format of SOAP requests and responses sent to and from XML Web service methods within the XML Web service.

Inheritance Hierarchy

System.Object
System.Attribute
System.Web.Services.Protocols.SoapRpcServiceAttribute

Namespace: System.Web.Services.Protocols
Assembly: System.Web.Services (in System.Web.Services.dll)

Syntax

Visual Basic

<AttributeUsageAttribute(AttributeTargets.Class)> _
Public NotInheritable Class SoapRpcServiceAttribute _
	Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.Class)]
public sealed class SoapRpcServiceAttribute : Attribute

Visual C++

[AttributeUsageAttribute(AttributeTargets::Class)]
public ref class SoapRpcServiceAttribute sealed : public Attribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class)>]
type SoapRpcServiceAttribute =  
    class
        inherit Attribute
    end

The SoapRpcServiceAttribute type exposes the following members.

Constructors

	Name	Description
	SoapRpcServiceAttribute	Initializes a new instance of the SoapRpcServiceAttribute class.

Top

Properties

	Name	Description
	RoutingStyle	Gets or sets how SOAP messages are routed to the XML Web service.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
	Use	Gets or sets the binding used when invoking the Web service's methods.

Top

Methods

	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.)

Top

Explicit Interface Implementations

	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.)

Top

Remarks

The SoapRpcServiceAttribute allows you to set the default encoding style for XML Web service methods within an XML Web service to RPC method encoding and Encoded parameter encoding.

Web Services Description Language (WSDL) defines two styles for how an XML Web service method, or operation, can be encoded in a SOAP request or a SOAP response: RPC and Document. The RPC style refers to encoding the XML Web service method according to section 7 of the SOAP specification for using SOAP for RPC. This style specifies that all parameters are encapsulated within a single element named after the XML Web service method, and that each element within that element represents a parameter named after its respective parameter name.

To set the default method level encoding to Document, apply a SoapDocumentServiceAttribute to the class implementing the XML Web service.

For more details, see [<topic://cpconCustomizingSOAPInASPNETWebServicesWebServiceClients>].

This attribute can be applied to a class implementing an XML Web service.

Examples

The following example shows how to use the SoapRpcServiceAttribute class.

Visual Basic


<%@ WebService Language="VB" Class="SumService" %>

Imports System
Imports System.Web.Services
Imports System.Web.Services.Protocols
Imports System.Web.Services.Description

	<SoapRpcServiceAttribute(RoutingStyle:=SoapServiceRoutingStyle.SoapAction)> _
	Public Class SumService 
          Inherits System.Web.Services.WebService
	
		<WebMethod> _
		Public Function Add(a As Integer, b as Integer)
		   return a + b
		End Function
	End Class


<%@ WebService Language="c#" Class="SumService" %>

using System;
using System.Web.Services;
using System.Web.Services.Protocols;
using System.Web.Services.Description;

	[SoapRpcService(RoutingStyle=SoapServiceRoutingStyle.SoapAction)]
	public class SumService : System.Web.Services.WebService
	{
		[WebMethod]
		public int Add(int a, int b)
		{
			return a + b;
		}
	}

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

System.Web.Services.Protocols Namespace

SoapDocumentServiceAttribute

SoapRpcMethodAttribute

SoapBindingUse

SoapServiceRoutingStyle