ObjectHandle Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Wraps marshal-by-value object references, allowing them to be returned through an indirection.

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


Public Class ObjectHandle
	Inherits MarshalByRefObject
	Implements IObjectHandle


Initializes an instance of the ObjectHandle class, wrapping the given object o.


Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)


Gets the Type of the current instance.(Inherited from Object.)


Initializes the lifetime lease of the wrapped object.(Overrides MarshalByRefObject.InitializeLifetimeService().)


Creates a shallow copy of the current Object.(Inherited from Object.)


Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)


Returns a string that represents the current object.(Inherited from Object.)


Returns the wrapped object.

The ObjectHandle class is used to pass an object (in a wrapped state) between multiple application domains without loading the metadata for the wrapped object in each AppDomain through which the ObjectHandle travels. Thus, the ObjectHandle class gives the caller control of when the Type of the remote object is loaded into a domain.

The following code example shows how to create an object in another AppDomain, and retrieve a proxy to the object from a ObjectHandle. In this example, you can assume that the code of the MyType class is compiled into an assembly called "ObjectHandleAssembly".

Imports System
Imports System.Runtime.Remoting

Public Class MyType
   Inherits MarshalByRefObject

   Public Sub New()
      Console.Write("Created an instance of MyType in an AppDomain with the ")
      Console.WriteLine("hashcode {0}", AppDomain.CurrentDomain.GetHashCode())
   End Sub 'NewNew

   Public Function GetAppDomainHashCode() As Integer
      Return AppDomain.CurrentDomain.GetHashCode()
   End Function 'GetAppDomainHashCode

End Class 'MyType

Class Test

   Public Shared Sub Main()

      Console.WriteLine("The hash code of the default AppDomain is {0}.", AppDomain.CurrentDomain.GetHashCode())

      ' Creates another AppDomain.
      Dim domain As AppDomain = AppDomain.CreateDomain("AnotherDomain", Nothing, CType(Nothing, AppDomainSetup))

      ' Creates an instance of MyType defined in the assembly called ObjectHandleAssembly.
      Dim obj As ObjectHandle = domain.CreateInstance("ObjectHandleAssembly", "MyType")

      ' Unwrapps the proxy to the MyType object created in the other AppDomain.
      Dim testObj As MyType = CType(obj.Unwrap(), MyType)

      If RemotingServices.IsTransparentProxy(testObj) Then
         Console.WriteLine("The unwrapped object is a proxy.")
         Console.WriteLine("The unwrapped object is not a proxy!")
      End If 
      Console.Write("Calling a method on the object located in an AppDomain with the hash code ")

   End Sub 'Main 

End Class 'Test 

.NET Framework
Available since 1.1

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

Return to top