HostingEnvironment.RegisterObject(IRegisteredObject) Method

Definition

Places an object in the list of registered objects for the application.

public:
 static void RegisterObject(System::Web::Hosting::IRegisteredObject ^ obj);
public static void RegisterObject (System.Web.Hosting.IRegisteredObject obj);
static member RegisterObject : System.Web.Hosting.IRegisteredObject -> unit
Public Shared Sub RegisterObject (obj As IRegisteredObject)

Parameters

obj
IRegisteredObject

The object to register.

Examples

The following code example is an implementation of a Start method for a registered object. For the full code required to run the example, see the Example section of the IRegisteredObject interface overview topic.

public void Start()
{
  HostingEnvironment.RegisterObject(this);
}
Public Sub Start()
  HostingEnvironment.RegisterObject(Me)
End Sub

Remarks

The ApplicationManager class enables methods outside the current application domain to create, manage, and destroy objects inside the current application domain. The RegisterObject method is used to register previously created objects with the hosting environment. Objects registered with the RegisterObject method must implement the IRegisteredObject interface.

To use a registered object, follow these steps:

  1. Create a new instance of your registered object by calling the ApplicationManager.CreateObject method.

  2. Call a type-specific method to initialize your new object. In the initialization method, call the RegisterObject method to add the object to the list of registered objects.

  3. Call the ApplicationManager.GetObject method to return the registered object when required.

  4. When you wish to stop your object, call the ApplicationManager.StopObject method. The ApplicationManager.StopObject method in turn calls the IRegisteredObject.Stop method.

  5. In the IRegisteredObject.Stop method, have your object call the UnregisterObject method.

Applies to

See also