VCPurge

Version:

6.0

Description:

Permanently removes all entities from the drawing which were marked as purged.

Declaration:

C/C++

extern "C" void WINAPI VCPurge(short* iError);

Delphi

procedure VCPurge(var iError: Smallint); stdcall;

ActiveX/COM

Sub Purge()

Parameters:

None.

Return Value:

None.

iError Code:

0 - Success
1 - Invalid world

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. VCPurge will permanently remove from the drawing all entities which have been marked as purged. Unlike VCPackData or VCPurgeErasedEntities, VCPurge leaves erased entities in the drawing unless they are also marked as purged and preserves the undo and redo levels of the remaining entities. VCPurge is typically used after a non-undoable tool completes in order to permanently remove any temporary or intermediate entities which are no longer required. If the tool is designed to be undoable or to modify undo and/or redo levels of entities, then VCPurgeRedo is preferred.