formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Editing Operations
Description
Returns the information about a parameter of a controled (parametric) object. The cntl_uuid argument is the unique identifier id (UUID) of the object type. For a given object this id can be retrieved with the function . The parm_indx argument identified the nth parameter of the object type. The api function can be used to determine the number of parameters of a controlled object.
Plugin Prototype
fzrt_error_td fz_objt_edit_parm_get_info(
fzrt_int | windex, |
cntl_uuid, | |
fzrt_int | parm_indx, |
parm_uuid, | |
parm_name, | |
parm_type, | |
parm_format_int, | |
parm_format_float, | |
parm_fuim_item, | |
fzrt_int * | parm_range, |
parm_range_min, | |
parm_range_max, | |
fzrt_int * | flags ) |
Parameters
windex [Input]
project window index
cntl_uuid [Input]
object type UUID
parm_indx [Input]
parameter index to retrieve
parm_uuid [Result, Optional]
uuid of parameter
parm_name [Result, Optional]
name of parameter
parm_type [Result, Optional]
data type of parameter
parm_format_int [Result, Optional]
integer format id of data
parm_format_float [Result, Optional]
float format id of data
parm_fuim_item [Result, Optional]
The type of dialog item with which to display the parameter. Note, that only certain dialg items can be used for a given data type.
parm_range [Result, Optional]
bit encoded range flags of data. (see fz_fuim_range_enum)
parm_range_min [Result, Optional]
minimum range value of data
parm_range_max [Result, Optional]
maximum range value of data
flags [Result, Optional]
bit encoded flags. (see fz_otyp_parm_flags_enum).
Returns
Error codes
Availability
6.0.0.0
Function Set
Defined in