MKI_InstanceInsert (Entity Creation) Changed in Version 2019.0

C++ Syntax

MKI_ENTITY_INSTANCE_PTR

MKI_InstanceInsert(

 MKI_CONST_ENTITY_PTR f_pRefEntity,

 bool f_fEmbedded );

Inserts the provisional instance (see MKI_InstanceOpen) to a memory list. If no provisional clipping surface, extended object, group, or block is currently open, the instance is inserted to the main memory list of the drawing behind the object pointed to by RefEntity. If RefEntity is nullptr, the instance is appended at the end.

If a provisional clipping surface, extended object, group, or block is currently open (in that order), the instance is appended to that entity. RefEntity is ignored in this case.

In most cases, you can use MKI_InstanceFastInsert instead of this procedure to speed up execution and to reduce code size. See the description of that procedure for details.

Parameters

RefEntity

[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 2014.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 inserted instance. Returns nullptr if the insertion was not successful, normally due to insufficient memory.