VCIsCurrentEntityPurged

Version:

6.0

Description:

Gets the purged flag for the current entity.

Declaration:

C/C++

extern "C" vbool WINAPI VCIsCurrentEntityPurged(short* iError);

Delphi

function VCIsCurrentEntityPurged(var iError: Smallint):Wordbool; stdcall;

ActiveX/COM

Function IsCurrentEntityPurged() As Integer

Parameters:

None.

Return Value:

The current state of the purged toggle.
0 - false
1 - true

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 VCIsCurrentEntityPurged to determine is the entity is marked as purged.