ServiceBase.OnPause Method

Definition

When implemented in a derived class, executes when a Pause command is sent to the service by the Service Control Manager (SCM). Specifies actions to take when a service pauses.

protected:
 virtual void OnPause();
protected virtual void OnPause ();
abstract member OnPause : unit -> unit
override this.OnPause : unit -> unit
Protected Overridable Sub OnPause ()

Remarks

Use OnPause to specify the processing that occurs when the service receives a Pause command. OnPause is expected to be overridden when the CanPauseAndContinue property is true.

When you continue a paused service (either through the Services console or programmatically), the OnContinue processing is run, and the service becomes active again.

The Pause command only allows your application to react to a specific event. OnPause does nothing to the service that you do not define it to do.

Sending a Pause request to the service can conserve system resources because Pause need not release all system resources. For example, if threads have been opened by the process, pausing a service rather than stopping it can allow the threads to remain open, obviating the need to reallocate them when the service continues. If you define Pause to release all system resources, it behaves like a Stop command.

Set CanPauseAndContinue to true, and override OnPause and OnContinue to specify the processing that should occur when the SCM passes a Pause or Continue request to your service. OnContinue should be implemented to undo the processing in OnPause.

If CanPauseAndContinue is false, the SCM will not pass Pause or Continue requests to the service, so the OnPause and OnContinue methods will not be called even if implemented. In the SCM, the Pause and Continue controls are disabled when CanPauseAndContinue is false.

Applies to

See also