formZ SDK | 4.0 Call Back Reference | Surface Style Representation

# fz_srep_cbak_parm_info

Description

Surface Style Representation parameter get info function. (Optional). Returns information about the nth paramater of the surface style representation, 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 fz_srep_cbak_parm_count function.
The uuid in parm_uuid uniquely identifies the parameter, and is used in fz_srep_cbak_parm_get and fz_srep_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 automatically created by formZ. Note that only certain dialog items can be used for a given data type. (see fz_otyp_cbak_parm_info2 for a list). For those dialog items that require additional strings, such as menus and sets of radio buttons, the must be implemented to define those strings.

Plugin Prototype

fzrt_error_td fz_srep_cbak_parm_info(

fzrt_int | windex,
void * | srep_data,
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_item_type,
fzrt_int * | parm_range,
fz_type_td * | parm_range_min,
fz_type_td * | parm_range_max,
fzrt_int * | flags )

Parameters

windex [Input]

project window index

srep_data [Input]

The data of Surface Style Representation. If passed as NULL, the index refers to the list of all possible 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_item_type [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_srep_parm_flags_enum).

Returns

Error codes

Availability

7.0.0.0

See Also

fz_srep_cbak_parm_count, , , fz_srep_cbak_parm_set, fz_srep_cbak_parm_get

Function Set

fz_srep_cbak_fset

Defined in

fz_srep_api.h