ServiceBase.CanStop Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets a value indicating whether the service can be stopped once it has started.
public:
property bool CanStop { bool get(); void set(bool value); };
public bool CanStop { get; set; }
member this.CanStop : bool with get, set
Public Property CanStop As Boolean
Property Value
true
if the service can be stopped and the OnStop() method called; otherwise, false
.
Exceptions
The service has already been started. The CanStop property cannot be changed once the service has started.
Remarks
When Stop is called on a service, the Service Control Manager (SCM) verifies whether the service accepts Stop commands using the value of CanStop. For most services, the value of CanStop is true
, but some operating system services, for example, do not allow the user to stop them.
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 derived class, the SCM handles the Stop command through the empty base class ServiceBase.OnStop method.