Version: |
6.0 |
Description: |
Permanently removes all entities from the drawing which were marked as purged in addition to any erased entities which have an undo level greater than or equal to the current undo level of the drawing. All unerased entities have their redo levels reset to 0 (zero). |
Declaration: |
|
C/C++ |
extern "C" void WINAPI VCPurgeRedo(short* iError); |
Delphi |
procedure VCPurgeRedo(var iError: Smallint); stdcall; |
ActiveX/COM |
Sub PurgeRedo() |
Parameters: |
None. |
Return Value: |
None. |
iError Code: |
0 - Success |
Notes: |
A purged entity is still in the drawing database but has been marked as purged. A purged entity is not subject to Undo/Redo unlike an entity which is erased but not purged. Purged entities may be later marked as not purged and recovered for future use or permanently removed from the drawing. Like VCPurge, VCPurgeRedo will permanently remove from the drawing all entities which have been marked as purged. In addition, VCPurgeRedo will also permanently remove any erased entities which have an undo level greater than or equal to the current undo level of the drawing. Removing these entities is useful when your tool has added new entities at the current undo level of the drawing so that previously added and subsequently undone entities should not re-enter the drawing. Lastly, all unerased entities have their redo levels reset to 0 (zero) for the same reason that previously undone entities should not be redone and re-enter the drawing. VCPurgeRedo is typically used after a tool completes in order to permanently remove any temporary or intermediate entities which are no longer required. VCPurgeRedo is preferred over VCPurge when it is known that entities have been previously undone by the user or by your tool, or when the tool has directly modified entity undo or redo levels. If there is any uncertainty, VCPurgeRedo is preferred. |
See Also: |
VCSetCurrentEntityPurged, VCIsCurrentEntityPurged, VCPurge, VCSetCurrentEntityUndo, VCSetCurrentEntityRedo, VCPackData, VCPurgeErasedEntities |