VCSetCurrentEntityPurged

Version:

6.0

Description:

Sets the purged flag for the current entity.

Declaration:

C/C++

extern "C" void WINAPI VCSetCurrentEntityPurged(short* iError, vbool tf);

Delphi

procedure VCSetCurrentEntityPurged(var iError: Smallint; tf: Wordbool); stdcall;

ActiveX/COM

Sub SetCurrentEntityPurged(ByVal tf As Integer)

Parameters:

tf - toggle setting
0 - not purged
1 - purged

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, meaning it will be permanently removed from the database when routines such as VCPurge, VCPurgeRedo, or other operations remove purged entities. A purged entity is not subject to Undo/Redo unlike an entity which is erased but not purged. Call VCSetCurrentEntityPurged to set the purged flag for the current entity. If setting the current entity to be purged and it is not already erased, then the current entity is erased in the same way that VCSetCurrentErased erases entities and also marked as purged, which means the entity will be deselected, erased, purged, and assigned a redo level. Otherwise, the current entity is only marked as not purged or purged according the toggle setting. This function can be used to manage intermediate entities created by tools to either keep them in the database for future use or for Undo/Redo or to remove them from the database.