This documentation is archived and is not being maintained.

ReturnMessage Class

Holds a message returned in response to a method call on a remote object.


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

[SecurityPermissionAttribute(SecurityAction::InheritanceDemand, Flags = SecurityPermissionFlag::Infrastructure)]
public ref class ReturnMessage : IMethodReturnMessage, 
	IMethodMessage, IMessage

The ReturnMessage type exposes the following members.

Public methodReturnMessage(Exception, IMethodCallMessage)Initializes a new instance of the ReturnMessage class.
Public methodReturnMessage(Object, array<Object>, Int32, LogicalCallContext, IMethodCallMessage)Initializes a new instance of the ReturnMessage class with all the information returning to the caller after the method call.

Public propertyArgCountGets the number of arguments of the called method.
Public propertyArgsGets a specified argument passed to the method called on the remote object.
Public propertyExceptionGets the exception that was thrown during the remote method call.
Public propertyHasVarArgsGets a value indicating whether the called method accepts a variable number of arguments.
Public propertyLogicalCallContextGets the LogicalCallContext of the called method.
Public propertyMethodBaseGets the MethodBase of the called method.
Public propertyMethodNameGets the name of the called method.
Public propertyMethodSignatureGets an array of Type objects containing the method signature.
Public propertyOutArgCountGets the number of out or ref arguments on the called method.
Public propertyOutArgsGets a specified object passed as an out or ref parameter to the called method.
Public propertyPropertiesGets an IDictionary of properties contained in the current ReturnMessage.
Public propertyReturnValueGets the object returned by the called method.
Public propertyTypeNameGets the name of the type on which the remote method was called.
Public propertyUriGets or sets the URI of the remote object on which the remote method was called.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetArgReturns a specified argument passed to the remote method during the method call.
Public methodGetArgNameReturns the name of a specified method argument.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetOutArgReturns the object passed as an out or ref parameter during the remote method call.
Public methodGetOutArgNameReturns the name of a specified out or ref parameter passed to the remote method.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)


This class makes a link demand and an inheritance demand at the class level. A SecurityException is thrown when either the immediate caller or the derived class does not have infrastructure permission. For details about security demands, see Link Demands and Inheritance Demands.

public ref class MyProxy: public RealProxy
   String^ stringUri;
   MarshalByRefObject^ myMarshalByRefObject;

   MyProxy( Type^ myType ) : RealProxy( myType )
      myMarshalByRefObject = dynamic_cast<MarshalByRefObject^>(Activator::CreateInstance( myType ));
      ObjRef^ myObject = RemotingServices::Marshal( myMarshalByRefObject );
      stringUri = myObject->URI;

   virtual IMessage^ Invoke( IMessage^ myMessage ) override
      IMethodCallMessage^ myCallMessage = (IMethodCallMessage^)( myMessage );

      IMethodReturnMessage^ myIMethodReturnMessage =
         RemotingServices::ExecuteMessage( myMarshalByRefObject, myCallMessage );

      Console::WriteLine( "Method name : {0}", myIMethodReturnMessage->MethodName );
      Console::WriteLine( "The return value is : {0}", myIMethodReturnMessage->ReturnValue );

      // Get number of 'ref' and 'out' parameters.
      int myArgOutCount = myIMethodReturnMessage->OutArgCount;
      Console::WriteLine( "The number of 'ref', 'out' parameters are : {0}",
         myIMethodReturnMessage->OutArgCount );
      // 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 ) );
      array<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.

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