Application.SetSuspendState(PowerState, Boolean, Boolean) Method

Definition

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

public:
 static bool SetSuspendState(System::Windows::Forms::PowerState state, bool force, bool disableWakeEvent);
public static bool SetSuspendState (System.Windows.Forms.PowerState state, bool force, bool disableWakeEvent);
static member SetSuspendState : System.Windows.Forms.PowerState * bool * bool -> bool
Public Shared Function SetSuspendState (state As PowerState, force As Boolean, disableWakeEvent As Boolean) As Boolean

Parameters

state
PowerState

A PowerState indicating the power activity mode to which to transition.

force
Boolean

true to force the suspended mode immediately; false to cause Windows to send a suspend request to every application.

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

Returns

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.

Applies to

See also