This documentation is archived and is not being maintained.

ServiceBase.OnPowerEvent Method

When implemented in a derived class, executes when the computer's power status has changed. This applies to laptop computers when they go into suspended mode, which is not the same as a system shutdown.

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

protected virtual bool OnPowerEvent (
	PowerBroadcastStatus powerStatus
)
protected boolean OnPowerEvent (
	PowerBroadcastStatus powerStatus
)
protected function OnPowerEvent (
	powerStatus : PowerBroadcastStatus
) : boolean
Not applicable.

Parameters

powerStatus

A PowerBroadcastStatus that indicates a notification from the system about its power status.

Return Value

When implemented in a derived class, the needs of your application determine what value to return. For example, if a QuerySuspend broadcast status is passed, you could cause your application to reject the query by returning false.

Use OnPowerEvent to specify the processing that occurs when the system event indicated in the PowerBroadcastStatus enumeration occurs--for example, when the computer is placed in suspended mode or indicates low battery power.

OnPowerEvent is expected to be overridden when the CanHandlePowerEvent property is true.

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Show: