C++ Syntax

bool

MKI_PhysicalDeleteEntity(

MKI_ENTITY_PTR f_pEntity );

Physically and permanently deletes the given entity, i.e. it cannot be undeleted by the user.

The entity can either be part of the link list of any clipping surface, extended object, group, or block, or it can be part of the drawing's object list. Do not use to delete entities that were not yet added to any list (i.e. that were created in memory, but not yet inserted).

Example: If you create an object using MKI_ObjectOpen() - MKI_ObjectAddPoint() - MKI_ObjectAddEnd(), it has been temporarily created, but not yet permanently added to any list. If you do no longer required it, just call MKI_ObjectClose() to discard it. Once MKI_ObjectInsert() or MKI_ObjectFastInsert() has been called, the object was added to a list and can only be permanently deleted using this function.

This command should be used carefully, since it deletes an entity permanently. This only works correctly if the entity is either part of the drawing's object list or the link list of a superordinate entity pointed to by a valid m_pParent member. Do not use this function to try to delete any entity that is outside of this context!

Parameters

Entity

[MKI_ENTITY_PTR] Address of the entity to be physically deleted.

Return Value

Returns true if the entity has been deleted successfully. Else, false is returned.