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

# fz_objt_edit_refo_set_file_info

Description

Sets the file info for a reference object. This contains the information where the objects originally came from, such as a DWG drawing file or another formZ file. It also indicates whether all entities in the file were used or only entities from a given layer. This information may be used in the future to reload the data from the file, in case the file has changed.

Plugin Prototype

fzrt_error_td fz_objt_edit_refo_set_file_info(

fzrt_int | windex,
fz_objt_ptr | refo_obj,
fzrt_floc_ptr | floc,
fzrt_boolean | from_layer,
fz_string_td | layer_name )

Parameters

windex [Input]

project window index

refo_obj [Input]

the reference object

floc [Input]

the location of the file where the data originated from

from_layer [Input]

TRUE, if only objects from a given layer in the file are used. FALSE otherwise

layer_name [Input]

If from_layer is TRUE, this is the name of the layer in the file.

Returns

Error codes

Availability

7.0.0.0

Example Files

util_objt_cnstr_refo.fsl

Function Set

fz_model_fset

Defined in

fz_objt_refo_api.h