This documentation is archived and is not being maintained.

ServiceBase.CanShutdown Property

Gets or sets a value indicating whether the service should be notified when the system is shutting down.

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

public bool CanShutdown { get; set; }

Property Value

Type: System.Boolean
true if the service should be notified when the system is shutting down; otherwise, false.

ExceptionCondition
InvalidOperationException

The service has already been started. The CanShutdown property cannot be changed once the service has started.

If CanShutdown is true, the service is notified when the system is shutting down. At shutdown, the OnShutdown method is called if it has been implemented in your derived class.

NoteNote

Only the system should cause the OnShutdown method to execute; the service can call it, but this is not recommended.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: