ServiceBase::CanHandlePowerEvent 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 or sets a value indicating whether the service can handle notifications of computer power status changes.

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

public:
property bool CanHandlePowerEvent {
	bool get();
	void set(bool value);
}

Property Value

Type: System::Boolean

true if the service handles the computer power status changes indicated in the PowerBroadcastStatus class, otherwise, false.

Exception Condition
InvalidOperationException

This property is modified after the service was started.

When the computer power status changes, the Service Control Manager (SCM) verifies whether the service accepts power event commands using the value of CanHandlePowerEvent.

If CanHandlePowerEvent is true, the command is passed to the service and the OnPowerEvent method is called if defined. If OnPowerEvent is not implemented in the derived class, the SCM handles the power event through the empty base class ServiceBase::OnPowerEvent method.

.NET Framework
Available since 1.1
Return to top
Show: