Click or drag to resize

IMcUndoableBackup Method

Saves the state of an object implementing this interface into a variant.

Namespace:  MediaCy.IQL.Engine
Assembly:  MediaCy.IQL.Engine (in MediaCy.IQL.Engine.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Sub Backup ( 
	<OutAttribute> ByRef BackupTo As Object,
	<OutAttribute> ByRef Context As Object,
	StateID As Integer,
	<OutAttribute> ByRef Operation As Integer,
	IsUndoState As Integer
)

Parameters

BackupTo
Type: SystemObject
VARIANT* : The variant where the current state will be stored. This is an [out] parameter (though it is declared [in,out] to make VB happy).
Context
Type: SystemObject
VARIANT* : A extra variant passed to the Push function as its Context argument. For saving McImage objects, this may be a source rectangle for the section of the image to be saved, given as a LONGRECT UDT or as an array of 4 numeric values in the order left, top, right, bottom. The Backup routine may change this VARIANT to reflect the actual source rectangle saved. If this is missing, then the source is determined by the Operation argument.
StateID
Type: SystemInt32
long : The internal unique ID for this operation, generated by the Undo-Redo manager.
Operation
Type: SystemInt32
long : A code describing the operation applied to the undoable saved by a Push, just after the Push occurs. This code may be used for optimization. For saving McImage objects, this may be one or more mcImageUndoOperationFlags OR'ed together. The Backup routine may change this value to reflect information about the actual information saved. Flags common to all undoable objects are defined in mcCommonUndoStackOperationFlags.
IsUndoState
Type: SystemInt32
BOOL : This boolean tells the undoable where its state will be saved (internal undo or redo stack). This boolean is used for optimization
Remarks
Has extra parameters, to allow memory optimization. Backup is never called directly, but is called indirectly as the result of an IMcUndoStack.Push or for the Redo stack as part of an Undo operation.
See Also