dbSetUndoHandle

dbSetUndoHandle(
t_handleName 
[ g_moveHandle ]
)
=> t / nil

Description

Sets an undo handle with the specified name on the current undo checkpoint. If there already exists a handle with the same name, you can optionally specify that the existing handle is moved from its current position in the undo stack and associated with the current undo checkpoint.

Arguments

t_handleName	Name of the handle name that needs to be set as the undo handle.
g_moveHandle	Controls what happens if there is an existing undo checkpoint with the same name. When set to t, the existing handle is moved to the current undo checkpoint and the undo checkpoint to which it was previously assigned becomes unnamed. When set to nil, if there is an existing undo checkpoint with the same name, an error is returned because the handle names must be unique.

Value Returned

t	The handle was set.
nil	The handle was not set.

Examples

Sets the undo handle, checkpoint5 on the current undo checkpoint.

dbSetUndoHandle("checkpoint5")

Sets the undo handle, checkpoint5 on the current undo checkpoint. The existing handle, checkpoint5, is moved to the current undo checkpoint and the undo checkpoint to which it was previously assigned becomes unnamed.

dbSetUndoHandle("checkpoint5" t)

Related Topics

Undo and Redo Functions

Return to top