.NET Framework Class Library
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)
Syntax

Visual Basic (Declaration)
Public Shared Function SetSuspendState ( _
    state As PowerState, _
    force As Boolean, _
    disableWakeEvent As Boolean _
) As Boolean
Visual Basic (Usage)
Dim state As PowerState
Dim force As Boolean
Dim disableWakeEvent As Boolean
Dim returnValue As Boolean

returnValue = Application.SetSuspendState(state, _
    force, disableWakeEvent)
C#
public static bool SetSuspendState(
    PowerState state,
    bool force,
    bool disableWakeEvent
)
Visual C++
public:
static bool SetSuspendState(
    PowerState state, 
    bool force, 
    bool disableWakeEvent
)
JScript
public static function SetSuspendState(
    state : PowerState, 
    force : boolean, 
    disableWakeEvent : boolean
) : boolean

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.
Remarks

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.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0
See Also

Reference

Tags :


Page view tracker