formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Symbol

# fz_objt_symb_ins_explode

Description

Explodes a symbol instance object into its component objects. The object passed in as sym_obj must be a symbol instance. If flatten is TRUE, all nested symbol instances are exploded as well. That is, no symbol instances remain in the resulting list of objects. If flatten is FALSE, the symbol instance is exploded on level of nesting deep.
The pointers of the resulting objects are stored in the entity list passed in. If the resulting objects are to become part of the project's object list, each must be added via a call to fz_objt_add_objt_to_project.
Note, that the symbol instance object passed in remains unchanged (i.e. it is not deleted).

Plugin Prototype

fzrt_error_td fz_objt_symb_ins_explode(

fzrt_int | windex,
fz_objt_ptr | sym_obj,
fzrt_boolean | flatten,
fz_enty_list_ptr | ent_list )

Parameters

windex [Input]

project window index

sym_obj [Input]

symbol object

flatten [Input]

explode nested symbols

ent_list [Result]

list with resulting objects

Returns

Error codes

Availability

5.0.0.0

Example Files

util_symb_test.fsl

See Also

fz_symb_def_model_create,

Function Set

fz_model_fset

Defined in

fz_objt_symb_api.h