This documentation is archived and is not being maintained.

SoapRpcMethodAttribute Class

Applying the SoapRpcMethodAttribute to a method specifies that SOAP messages sent to and from the method use RPC formatting.

For a list of all members of this type, see SoapRpcMethodAttribute Members.


[Visual Basic]
NotInheritable Public Class SoapRpcMethodAttribute
   Inherits Attribute
public sealed class SoapRpcMethodAttribute : Attribute
public __gc __sealed class SoapRpcMethodAttribute : public
class SoapRpcMethodAttribute extends Attribute

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.


Web Services Description Language (WSDL) defines two styles for how an XML Web service method, which it calls an operation, can be formatted in a SOAP message: RPC and Document. RPC formatting refers to formatting the operation according to the SOAP specification for using SOAP for RPC; otherwise known as Section 7 of the SOAP specification. RPC formatting states that all parameters are encapsulated within a single XML element named after the XML Web service method and that each XML element within that XML element represents a parameter named after the parameter it is representing.

SOAP messages formatted in both the RPC and Document styles can be used to communicate with an XML Web service in a Remote Procedure Call (RPC) manner; however the Document style can also easily be used to communicate in a loosely coupled manner. Therefore, Document style XML Web services is recommended. For more details, see the Customizing SOAP Messages topic.

For more details, see Customizing SOAP Messages.This attribute can be applied to an XML Web service method on the server and a proxy class on the client. XML Web service methods that have the OneWay property set to true do not have access to their HttpContext. As such, accessing any of the properties of the WebService class return a null reference (Nothing in Visual Basic).


[Visual Basic, C#] The following code example sets the message style to Rpc for the GetUserName XML Web service method.

[Visual Basic] 
<%@ WebService Language="VB" class="MyUser" %>
Imports System
Imports System.Web.Services
Imports System.Web.Services.Protocols

Public Class MyUser
    Inherits WebService    
    <SoapRpcMethod(Action := "", _
    RequestNamespace := "", _
    RequestElementName := "GetUserNameRequest", _
    ResponseNamespace := "", _
    ResponseElementName := "GetUserNameResponse"), _
    WebMethod(Description := "Obtains the User Name")> _
    Public Function _
        GetUserName() As UserName
        Dim temp As String
        Dim pos As Integer
        Dim NewUser As New UserName()
        ' Get the full user name, including the domain name if applicable.
        temp = User.Identity.Name
        ' Determine whether the user is part of a domain by searching for a backslash.
        pos = temp.IndexOf("\")
        ' Parse out the domain name from the string, if one exists.
        If pos <= 0 Then
            NewUser.Name = User.Identity.Name
            NewUser.Name = temp.Remove(0, pos + 1)
            NewUser.Domain = temp.Remove(pos, temp.Length - pos)
        End If
        Return NewUser
    End Function
End Class 

Public Class UserName
    Public Name As String
    Public Domain As String
End Class

<%@ WebService Language="C#" class="MyUser" %>
 using System;
 using System.Web.Services;
 using System.Web.Services.Protocols;
 public class MyUser : WebService {
       [ SoapRpcMethod(Action="", 
      [ WebMethod(Description="Obtains the User Name") ]
      public UserName GetUserName() {
           string temp;
           int pos;
           UserName NewUser = new UserName();
           // Get the full user name, including the domain name if applicable.
           temp = User.Identity.Name;
           // Determine whether the user is part of a domain by searching for a backslash.
           pos = temp.IndexOf("\\");
           // Parse out the domain name from the string, if one exists.
           if (pos <= 0)
                 NewUser.Name = User.Identity.Name;
           else {
               NewUser.Name = temp.Remove(0,pos+1);
                 NewUser.Domain = temp.Remove(pos,temp.Length-pos);
       return NewUser;
 public class UserName {
     public string Name;
     public string Domain;

[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter button Language Filter in the upper-left corner of the page.


Namespace: System.Web.Services.Protocols

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

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

See Also

SoapRpcMethodAttribute Members | System.Web.Services.Protocols Namespace | SoapDocumentMethodAttribute | SoapRpcServiceAttribute | SoapDocumentServiceAttribute