Computer - Hibernate

Declaration

<AMCOMPUTER ACTIVITY="hibernate" WAKEDELAY="number" MEASURE="text (options)" WAKETIME="number" IGNOREWHENLATE="YES/NO" FORCE="YES/NO" />

Related Topics   

Description

Powers down the computer while retaining its state.

Practical usage

When used to save power, hibernation is similar to sleep mode and saves more power at the cost of slower resumption. Hibernation is a means of avoiding the burden of saving unsaved data before shutting down and restoring all running programs after powering back on.

Parameters

General

Property Type Required Default Markup Description

Wake up

 --- --- --- --- If enabled, specifies that a wake up delay or specific wake up time should be set after the computer goes into hibernation.
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes.
After this delay Number No 30 WAKEDELAY="5" If enabled, specifies the amount of time that should elapse after the computer goes into hibernation before it should automatically resume normal operation (enabled by default). If this parameter is enabled, the At this time parameter becomes inactive.
Wake Measure Text (options) No Minutes
  • MEASURE="milliseconds"
  • MEASURE="seconds"
  • MEASURE="minutes"
  • MEASURE="hours"
 Specifies the time measurement that should correspond with the numeric value entered under the After this delay parameter. The available options are:
  • Milliseconds - The value specified in the After this delay parameter is measured in milliseconds.
  • Seconds - The value specified in the After this delay parameter is measured in seconds.
  • Minutes - The value specified in the After this delay parameter is measured in minutes.
  • Hours - The value specified in the After this delay parameter is measured in hours.
At this time Number No (current time)

WAKETIME="122236"

If enabled, denotes that the computer should wake up from hibernation at the time specified (disabled by default). If this parameter is enabled, the After this delay parameter becomes inactive.
Ignore step if specified time has passed Yes/No No No IGNOREWHENLATE="YES" If selected, the step will be ignored if the time specified in the At this time parameter has already passed. Disabled by default.
Message to display in the shut down dialog Text No (Empty) MESSAGE="Please begin to panic now" A user-defined message that windows should display on the restart notification dialog. This parameter is active only if the Prompt user to log off parameter is selected. The message will be displayed for the number of seconds, minutes or hours specified in the Shutdown after  parameter.
Force hibernate (do not send permission request to applications) Yes/No No No FORCE="YES" If selected, specifies that the computer should hibernate immediately without notifying and waiting for applications to return a message that they are ready to close.

Description

Error Causes

On Error

Examples

NOTE:
  • Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
  • To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.

This sample task puts the local computer into hibernation mode.  

Copy 
<AMCOMPUTER ACTIVITY="hibernate" WAKEDELAY="12" MEASURE="hours" FORCE="YES" />