MKI_ClipFastInsert (Entity Creation) Changed in Version 2024.1

C++ Syntax

MKI_ENTITY_CLIP_PTR

MKI_ClipFastInsert(

 MKI_CONST_ENTITY_PTR f_pRefEntity );

This procedure terminates the most recently opened provisional clipping surface (see MKI_ClipOpen) and inserts it to another clipping surface, a provisional extended object, group, block, or to the current drawing (in that order).

Parameters

RefEntity New in Version 2022.2

[MKI_CONST_ENTITY_PTR] Address of a reference entity behind which the clipping surface shall be inserted. If RefEntity is nullptr, the clipping surface is appended at the end.

Return Value

Returns the address of the new clipping surface if it was successfully inserted. Returns nullptr if the insertion was not successful, normally due to insufficient memory.

Regardless of the result, the provisional clipping surface is closed afterwards (either because it was not open to start with, or because it was just closed before trying to insert it).

Comment

This procedure is a kind of macro that executes steps similar to the following code segment:

MKI_ClipAddEnd();

MKI_ENTITY_CLIP_PTR pNewEntity = MKI_ClipInsert( f_pRefEntity );

MKI_ClipClose();

return( pNewEntity );

This causes the provisional clipping surface to be terminated, initialized and then inserted to the current drawing. Afterwards, it is closed. For a detailed description, see the referenced procedure's descriptions.

If possible, you should use this command instead of calling the separate procedures to increase speed and to reduce code size.