formZ SDK | 4.0 Call Back Reference | Object Type

# fz_otyp_cbak_parm_get_info2

Description

Object type parameter get info function (Optional or plugins, required for scripts). Returns information about the nth paramater of the object type, identified by "parm_indx". Pass in NULL for information not desired.
To get information about all parameters, iterate through the parameters up until the number of parameters returned by the function.
The uuid in parm_uuid uniquely identifies the parameter, and is used in fz_otyp_cbak_parm_get and fz_otyp_cbak_parm_set to identify which parameter is being retrieved or set.
The parm_fuim_item argument defines how to display a parameter in a dialog, such as the animation tack edit of the edit dialog if it is autoamtically created by formZ. Note, that only certain dialg items can be used for a given data type. The are alisted below. For those dialog items, that require additional strings, such as menus and sets of radio buttons, the fz_otyp_cbak_parm_get_state_str must be implemented to define those strings.
All integer types :
FZ_FUIM_ITEM_TEXT
FZ_FUIM_ITEM_MENU
FZ_FUIM_ITEM_SLIDER
FZ_FUIM_ITEM_SLIDER_TEXT
FZ_FUIM_ITEM_RADIO
fzrt_boolean :
FZ_FUIM_ITEM_MENU
FZ_FUIM_ITEM_RADIO
FZ_FUIM_ITEM_CHECK
All floating point types :
FZ_FUIM_ITEM_TEXT
FZ_FUIM_ITEM_SLIDER
FZ_FUIM_ITEM_SLIDER_TEXT
fz_string_td :
FZ_FUIM_ITEM_TEXT
fz_xy_td :
FZ_FUIM_ITEM_TEXT
fz_xyz_td :
FZ_FUIM_ITEM_TEXT
If an inappropriate item type is returned for a parameter, FZ_FUIM_ITEM_TEXT will be used instead. Parameters with data types not listed above are currently not displayed in a dialog.

Plugin Prototype

fzrt_error_td fz_otyp_cbak_parm_get_info2(

fzrt_int | parm_indx,
fzrt_UUID_td | parm_uuid,
fz_string_td | parm_name,
fz_type_enum * | parm_type,
fz_fuim_format_int_enum * | parm_format_int,
fz_fuim_format_float_enum * | parm_format_float,
fz_fuim_item_type_enum * | parm_fuim_item,
fzrt_int * | parm_range,
fz_type_td * | parm_range_min,
fz_type_td * | parm_range_max,
fzrt_int * | flags )

Parameters

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

See Also

fz_otyp_cbak_parm_get_state_str, fz_otyp_cbak_parm_get, fz_otyp_cbak_parm_set,

Function Set

fz_otyp_cbak_fset

Defined in

fz_otyp_api.h