System.Runtime.Remoting.Messaging.IMethodReturnMessage Interface

Assembly: Mscorlib.dll
Namespace: System.Runtime.Remoting.Messaging
Summary
Defines the method call return message interface.
C# Syntax:
public interface IMethodReturnMessage : IMethodMessage, IMessage
Remarks
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.
See also:
System.Runtime.Remoting.Messaging Namespace

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

Public Properties
Exception Read-only

OutArgCount Read-only

Gets the number of arguments in the method call marked as ref or out parameters.
OutArgs Read-only

Returns the specified argument marked as a ref or an out parameter.
ReturnValue Read-only

Gets the return value of the method call.
Public Methods
GetOutArg Returns the specified argument marked as a ref or an out parameter.
GetOutArgName Returns the name of the specified argument marked as a ref or an out parameter.

Hierarchy:


System.Runtime.Remoting.Messaging.IMethodReturnMessage Member Details

Property: Exception (read-only)
Summary
Gets the exception thrown during the method call.
C# Syntax:
Exception Exception {get;}

Return to top


Property: OutArgCount (read-only)
Summary
Gets the number of arguments in the method call marked as ref or out parameters.
C# Syntax:
int OutArgCount {get;}

Return to top


Property: OutArgs (read-only)
Summary
Returns the specified argument marked as a ref or an out parameter.
C# Syntax:
object[] OutArgs {get;}
Remarks
Although the IMethodReturnMessage.OutArgs property is redundant since the same functionality can be achieved through the IMethodReturnMessage.OutArgCount field and IMethodReturnMessage.GetOutArg method, there might be performance optimization available if the implementer understands when all the arguments will be retrieved.

Return to top


Property: ReturnValue (read-only)
Summary
Gets the return value of the method call.
C# Syntax:
object ReturnValue {get;}

Return to top


Method: GetOutArg(
   int argNum
)
Summary
Returns the specified argument marked as a ref or an out parameter.
C# Syntax:
object GetOutArg(
   int argNum
);
Parameters:

argNum

The number of the requested argument.

Return Value:
The specified argument marked as a ref or an out parameter.

Return to top


Method: GetOutArgName(
   int index
)
Summary
Returns the name of the specified argument marked as a ref or an out parameter.
C# Syntax:
string GetOutArgName(
   int index
);
Parameters:

index

The number of the requested argument name.

Return Value:
The argument name, or null if the current method is not implemented.

Return to top


Top of page

Copyright (c) 2002 Microsoft Corporation. All rights reserved.