System.Runtime.Remoting.Messaging.ReturnMessage Class

Summary

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

C# Syntax:

public class ReturnMessage : IMethodReturnMessage, IMethodMessage, IMessage

System.Runtime.Remoting.Messaging Namespace

System.Runtime.Remoting.Messaging.ReturnMessage Member List:

Public Constructors

ctor #1	Overloaded: .ctor(Exception e, IMethodCallMessage mcm) Initializes a new instance of the ReturnMessage class.
ctor #2	Overloaded: .ctor(object ret, object[] outArgs, int outArgsCount, LogicalCallContext callCtx, IMethodCallMessage mcm) Initializes a new instance of the ReturnMessage class with all the information returning to the caller after the method call.

Public Properties

ArgCount	Read-only Gets the number of arguments of the called method.
Args	Read-only Gets a specified argument passed to the method called on the remote object.
Exception	Read-only Gets the exception that was thrown during the remote method call.
HasVarArgs	Read-only Gets a value indicating whether the called method accepts a variable number of arguments.
LogicalCallContext	Read-only Gets the LogicalCallContext of the called method.
MethodBase	Read-only Gets the MethodBase of the called method.
MethodName	Read-only Gets the name of the called method.
MethodSignature	Read-only Gets an array of Type objects containing the method signature.
OutArgCount	Read-only Gets the number of out or ref arguments on the called method.
OutArgs	Read-only Gets a specified object passed as an out or ref parameter to the called method.
Properties	Read-only Gets an IDictionary of properties contained in the current ReturnMessage.
ReturnValue	Read-only Gets the object returned by the called method.
TypeName	Read-only Gets the name of the type on which the remote method was called.
Uri	Read-write Gets or sets the URI of the remote object on which the remote method was called.

Public Methods

Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetArg	Returns a specified argument passed to the remote method during the method call.
GetArgName	Returns the name of a specified method argument.
GetHashCode (inherited from System.Object)	See base class member description: System.Object.GetHashCode Derived from System.Object, the primary base class for all objects.
GetOutArg	Returns the object passed as an out or ref parameter during the remote method call.
GetOutArgName	Returns the name of a specified out or ref parameter passed to the remote method.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
ToString (inherited from System.Object)	See base class member description: System.Object.ToString Derived from System.Object, the primary base class for all objects.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

• System.Object
• System.Runtime.Remoting.Messaging.ReturnMessage

System.Runtime.Remoting.Messaging.ReturnMessage Member Details

Summary

Initializes a new instance of the ReturnMessage class.

C# Syntax:

public ReturnMessage(    Exception e,    IMethodCallMessage mcm );

e

The exception that was thrown during execution of the remotely called method.

mcm

An IMethodCallMessage with which to create an instance of the ReturnMessage class.

Return to top

Summary

Initializes a new instance of the ReturnMessage class with all the information returning to the caller after the method call.

C# Syntax:

public ReturnMessage(    object ret,    object[] outArgs,    int outArgsCount,    LogicalCallContext callCtx,    IMethodCallMessage mcm );

ret

The object returned by the invoked method from which the current ReturnMessage instance originated.

outArgs

The objects returned from the invoked method as out parameters.

outArgsCount

The number of out parameters returned from the invoked method.

callCtx

The LogicalCallContext of the method call.

mcm

The original method call to the invoked method.

Return to top

Summary

Gets the number of arguments of the called method.

C# Syntax:

public int ArgCount {get;}

Implements:

IMethodMessage.ArgCount

Return to top

Summary

Gets a specified argument passed to the method called on the remote object.

C# Syntax:

public object[] Args {get;}

Implements:

IMethodMessage.Args

Return to top

Summary

Gets the exception that was thrown during the remote method call.

C# Syntax:

public Exception Exception {get;}

Implements:

IMethodReturnMessage.Exception

Return to top

Summary

Gets a value indicating whether the called method accepts a variable number of arguments.

C# Syntax:

public bool HasVarArgs {get;}

Implements:

IMethodMessage.HasVarArgs

Return to top

Summary

Gets the LogicalCallContext of the called method.

C# Syntax:

public LogicalCallContext LogicalCallContext {get;}

Implements:

IMethodMessage.LogicalCallContext

Return to top

Summary

Gets the MethodBase of the called method.

C# Syntax:

public MethodBase MethodBase {get;}

Implements:

IMethodMessage.MethodBase

Return to top

Summary

Gets the name of the called method.

C# Syntax:

public string MethodName {get;}

Implements:

IMethodMessage.MethodName

Return to top

Summary

Gets an array of Type objects containing the method signature.

C# Syntax:

public object MethodSignature {get;}

Implements:

IMethodMessage.MethodSignature

Return to top

Summary

Gets the number of out or ref arguments on the called method.

C# Syntax:

public int OutArgCount {get;}

Implements:

IMethodReturnMessage.OutArgCount

Return to top

Summary

Gets a specified object passed as an out or ref parameter to the called method.

C# Syntax:

public object[] OutArgs {get;}

Implements:

IMethodReturnMessage.OutArgs

Return to top

Summary

Gets an IDictionary of properties contained in the current ReturnMessage.

C# Syntax:

public virtual IDictionary Properties {get;}

Implements:

IMessage.Properties

Return to top

Summary

Gets the object returned by the called method.

C# Syntax:

public virtual object ReturnValue {get;}

Implements:

IMethodReturnMessage.ReturnValue

Return to top

Summary

Gets the name of the type on which the remote method was called.

C# Syntax:

public string TypeName {get;}

Implements:

IMethodMessage.TypeName

Return to top

Summary

Gets or sets the URI of the remote object on which the remote method was called.

C# Syntax:

public string Uri {get; set;}

Implements:

IMethodMessage.Uri

Return to top

Inherited
See base class member description: System.Object.Equals

C# Syntax:

public virtual bool Equals(    object obj );

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.Finalize

C# Syntax:

~ReturnMessage();

For more information on members inherited from System.Object click on the link above.

Return to top

Summary

Returns a specified argument passed to the remote method during the method call.

C# Syntax:

public object GetArg(    int argNum );

argNum

The zero-based index of the requested argument.

Return Value:

An argument passed to the remote method during the method call.

Implements:

IMethodMessage.GetArg

Return to top

Summary

Returns the name of a specified method argument.

C# Syntax:

public string GetArgName(    int index );

index

The zero-based index of the requested argument name.

Return Value:

The name of a specified method argument.

Implements:

IMethodMessage.GetArgName

Return to top

Inherited
See base class member description: System.Object.GetHashCode

C# Syntax:

public virtual int GetHashCode();

For more information on members inherited from System.Object click on the link above.

Return to top

Summary

Returns the object passed as an out or ref parameter during the remote method call.

C# Syntax:

public object GetOutArg(    int argNum );

argNum

The zero-based index of the requested out or ref parameter.

Return Value:

The object passed as an out or ref parameter during the remote method call.

Implements:

IMethodReturnMessage.GetOutArg

Return to top

Summary

Returns the name of a specified out or ref parameter passed to the remote method.

C# Syntax:

public string GetOutArgName(    int index );

index

The zero-based index of the requested argument.

Return Value:

A string representing the name of the specified out or ref parameter, or null if the current method is not implemented.

Implements:

IMethodReturnMessage.GetOutArgName

Return to top

Inherited
See base class member description: System.Object.GetType

C# Syntax:

public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.MemberwiseClone

C# Syntax:

protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.ToString

C# Syntax:

public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top

Top of page