OnPowerEvent Method
Collapse the table of content
Expand the table of content

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.

[Visual Basic]
Protected Overridable Function OnPowerEvent( _
   ByVal powerStatus As PowerBroadcastStatus _
) As Boolean
[C#]
protected virtual bool OnPowerEvent(
 PowerBroadcastStatus powerStatus
);
[C++]
protected: virtual bool OnPowerEvent(
 PowerBroadcastStatus powerStatus
);
[JScript]
protected function OnPowerEvent(
   powerStatus : PowerBroadcastStatus
) : Boolean;

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.

Remarks

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.

Requirements

Platforms: Windows NT Server 4.0, Windows NT Workstation 4.0, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

ServiceBase Class | ServiceBase Members | System.ServiceProcess Namespace | CanHandlePowerEvent | OnContinue | OnPause | OnShutdown | OnStart | OnStop | OnCustomCommand

Show:
© 2016 Microsoft