This documentation is archived and is not being maintained.

IMethodReturnMessage Interface

Defines the method call return message interface.

Namespace:  System.Runtime.Remoting.Messaging
Assembly:  mscorlib (in mscorlib.dll)

public interface IMethodReturnMessage : IMethodMessage, 

The IMethodReturnMessage type exposes the following members.

Public propertyArgCountGets the number of arguments passed to the method. (Inherited from IMethodMessage.)
Public propertyArgsGets an array of arguments passed to the method. (Inherited from IMethodMessage.)
Public propertyExceptionGets the exception thrown during the method call.
Public propertyHasVarArgsGets a value indicating whether the message has variable arguments. (Inherited from IMethodMessage.)
Public propertyLogicalCallContextGets the LogicalCallContext for the current method call. (Inherited from IMethodMessage.)
Public propertyMethodBaseGets the MethodBase of the called method. (Inherited from IMethodMessage.)
Public propertyMethodNameGets the name of the invoked method. (Inherited from IMethodMessage.)
Public propertyMethodSignatureGets an object containing the method signature. (Inherited from IMethodMessage.)
Public propertyOutArgCountGets the number of arguments in the method call marked as ref or out parameters.
Public propertyOutArgsReturns the specified argument marked as a ref or an out parameter.
Public propertyPropertiesGets an IDictionary that represents a collection of the message's properties. (Inherited from IMessage.)
Public propertyReturnValueGets the return value of the method call.
Public propertyTypeNameGets the full Type name of the specific object that the call is destined for. (Inherited from IMethodMessage.)
Public propertyUriGets the URI of the specific object that the call is destined for. (Inherited from IMethodMessage.)

Public methodGetArgGets a specific argument as an Object. (Inherited from IMethodMessage.)
Public methodGetArgNameGets the name of the argument passed to the method. (Inherited from IMethodMessage.)
Public methodGetOutArgReturns the specified argument marked as a ref or an out parameter.
Public methodGetOutArgNameReturns the name of the specified argument marked as a ref or an out parameter.

A method call return message represents the response to a method call on an object at the end of the message sink. An IMethodReturnMessage is generated as a result of a method called on a remote object, and is used to return the results of the method call back to the caller.

The following example code shows a custom proxy that overrides RealProxy.Invoke in order to write the return message information to the console.

[PermissionSet(SecurityAction.Demand, Name="FullTrust")]
public class MyProxy : RealProxy
   String stringUri;
   MarshalByRefObject myMarshalByRefObject;

   public MyProxy(Type myType): base(myType)
      myMarshalByRefObject = (MarshalByRefObject)Activator.CreateInstance(myType);
      ObjRef myObject = RemotingServices.Marshal(myMarshalByRefObject);
      stringUri = myObject.URI;

   public override IMessage Invoke(IMessage myMessage)
      IMethodCallMessage myCallMessage = (IMethodCallMessage)myMessage;

      IMethodReturnMessage myIMethodReturnMessage =
         RemotingServices.ExecuteMessage(myMarshalByRefObject, myCallMessage);

      Console.WriteLine("Method name : " + myIMethodReturnMessage.MethodName);
      Console.WriteLine("The return value is : " + myIMethodReturnMessage.ReturnValue);

      // Get number of 'ref' and 'out' parameters.
      int myArgOutCount = myIMethodReturnMessage.OutArgCount;
      Console.WriteLine("The number of 'ref', 'out' parameters are : " +
      // Gets name and values of 'ref' and 'out' parameters.
      for(int i = 0; i < myArgOutCount; i++)
         Console.WriteLine("Name of argument {0} is '{1}'.",
            i, myIMethodReturnMessage.GetOutArgName(i));
         Console.WriteLine("Value of argument {0} is '{1}'.",
            i, myIMethodReturnMessage.GetOutArg(i));
      object[] myObjectArray = myIMethodReturnMessage.OutArgs; 
      for(int i = 0; i < myObjectArray.Length; i++)
         Console.WriteLine("Value of argument {0} is '{1}' in OutArgs",
            i, myObjectArray[i]);
      return myIMethodReturnMessage;

.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

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.