IRegisteredObject.Stop(Boolean) Method

Definition

Requests a registered object to unregister.

public:
 void Stop(bool immediate);
public void Stop (bool immediate);
abstract member Stop : bool -> unit
Public Sub Stop (immediate As Boolean)

Parameters

immediate
Boolean

true to indicate the registered object should unregister from the hosting environment before returning; otherwise, false.

Remarks

The application manager will call the Stop method to ask a registered object to unregister. During processing of the Stop method, the registered object must call the HostingEnvironment.UnregisterObject method.

The Stop method is first called with the immediate parameter set to false. The object can either complete processing, call the UnregisterObject method, and then return or it can return immediately and complete processing asynchronously before calling the UnregisterObject method.

If the registered object does not complete processing before the application manager's time-out period expires, the Stop method is called again with the immediate parameter set to true. When the immediate parameter is true, the registered object must call the UnregisterObject method before returning; otherwise, its registration will be removed by the application manager.

Applies to