MKI_InstanceFastInsert (Entity Creation) Changed in Version 2022.2

C++ Syntax

MKI_ENTITY_INSTANCE_PTR

MKI_InstanceFastInsert(

 MKI_CONST_ENTITY_PTR f_pRefEntity,

 bool f_fEmbedded );

This procedure terminates a currently opened provisional instance (see MKI_InstanceOpen) and inserts it to a currently open provisional clipping surface, 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 instance shall be inserted. If RefEntity is nullptr , the instance is appended at the end.

Embedded New in Version 2022.2

[bool] If true, the instance will be embedded, i.e. it will contain the referenced block's data as a copy. Will be ignored if the instance is not inserted to the main memory list or if the instance references an internal block.

Return Value

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

Regardless of the result, the provisional instance 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_InstanceAddEnd();

MKI_ENTITY_INSTANCE_PTR pNewEntity = MKI_InstanceInsert( f_pRefEntity, f_fEmbedded );

MKI_InstanceClose();

return( pNewEntity );

This causes the provisional instance 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.