This documentation is archived and is not being maintained.

Application.SetSuspendState Method

Suspends or hibernates the system, or requests that the system be suspended or hibernated.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public static bool SetSuspendState(
	PowerState state,
	bool force,
	bool disableWakeEvent
)

Parameters

state
Type: System.Windows.Forms.PowerState
A PowerState indicating the power activity mode to which to transition.
force
Type: System.Boolean
true to force the suspended mode immediately; false to cause Windows to send a suspend request to every application.
disableWakeEvent
Type: System.Boolean
true to disable restoring the system's power status to active on a wake event, false to enable restoring the system's power status to active on a wake event.

Return Value

Type: System.Boolean
true if the system is being suspended, otherwise, false.

If an application does not respond to a suspend request within 20 seconds, Windows determines that it is in a non-responsive state, and that the application can either be put to sleep or terminated. Once an application responds to a suspend request, however, it can take whatever time it needs to clean up resources and shut down active processes.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.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: