ServiceController.CanStop Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets a value indicating whether the service can be stopped after it has started.

Namespace:   System.ServiceProcess
Assembly:  System.ServiceProcess (in System.ServiceProcess.dll)

[ServiceProcessDescriptionAttribute("SPCanStop")]
public bool CanStop { get; }

Property Value

Type: System.Boolean

true if the service can be stopped and the OnStop method called; otherwise, false.

Exception Condition
Win32Exception

An error occurred when accessing a system API.

InvalidOperationException

The service was not found.

The following example demonstrates the use of the CanStop property to determine whether a service provides a handler for a stop event. This example is part of a larger example that is provided for the ServiceController class.

// Display properties for the Simple Service sample
// from the ServiceBase example.
ServiceController sc = new ServiceController("Simple Service");
Console.WriteLine("Status = " + sc.Status);
Console.WriteLine("Can Pause and Continue = " + sc.CanPauseAndContinue);
Console.WriteLine("Can ShutDown = " + sc.CanShutdown);
Console.WriteLine("Can Stop = " + sc.CanStop);

.NET Framework
Available since 1.1
Return to top
Show: