C++ Syntax

MKI_InstanceInsert(

bool f_fEmbed );

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 f_pRefEntity. If f_pRefEntity 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. f_pRefEntity 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

f_pRefEntity

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

f_fEmbed New in Version 2014.2

[bool] If true, the block will be embedded, i.e. the block data will become part of the drawing (increasing the drawing size significantly). Otherwise, the block data will only be referenced by library name (making the drawing dependent from the external library file). 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.