Export (0) Print
Expand All

ServiceBase.OnStop Method

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

[Visual Basic]
Protected Overridable Sub OnStop()
[C#]
protected virtual void OnStop();
[C++]
protected: virtual void OnStop();
[JScript]
protected function OnStop();

Remarks

Use OnStop to specify the processing that occurs when the service receives a Stop command.

When the SCM receives a Stop command, it uses the value of CanStop to verify whether the service accepts Stop commands. If CanStop is true, the Stop command is passed to the service, and the OnStop method is called if it is defined. If OnStop is not implemented in the service, the SCM handles the Stop command.

If CanStop is false, the SCM ignores the Stop command. It is not passed to the service. The Stop command returns and throws an exception.

OnStop is expected to be overridden in the derived class. For the service to be useful, OnStart and OnStop should both be implemented in your service class.

Requirements

Platforms: Windows NT Server 4.0, Windows NT Workstation 4.0, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

ServiceBase Class | ServiceBase Members | System.ServiceProcess Namespace | CanStop | OnContinue | OnPowerEvent | OnPause | OnShutdown | OnStart | OnCustomCommand

Show:
© 2014 Microsoft