RemoveHibernation

The RemoveHibernation function deletes a data item from the Hibernation data type and removes it from the hibernation queue.

To remove a hibernation, you call RemoveHibernation and pass the action key for the data item as an input parameter.

Syntax

The RemoveHibernation function has the following syntax:

RemoveHibernation(ActionKey)

Parameters

The RemoveHibernation function has the following parameter.

Table 1. RemoveHibernation function parameters
Parameter	Format	Description
`ActionKey`	String	String that uniquely identifies the hibernating policy.

Example

The following example shows how to remove a hibernation whose action key is ActionKey0001.

// Call RemoveHibernation and pass the action key
// for the hibernation as an input parameter
					
ActionKey = "ActionKey0001";
					
RemoveHibernation(ActionKey);