formZ SDK | 4.0 Call Back Reference | Surface Style Representation

# fz_srep_cbak_parm_state_str

Description

Surface Style Representation state parameter get string function (Optional). Given a parameter identified by its uuid, this function returns the nth string associated with the nth state of that variable. This is useful for integer or boolean parameters that have various strings associated with their values, as opposed to just the raw values. For example, a menu parameter may have strings for each menu item, and these would be useful when displaying this parameter data in other dialog interface contexts.

Plugin Prototype

fzrt_error_td fz_srep_cbak_parm_state_str(

fzrt_int | windex,
void * | srep_data,
fzrt_UUID_td | parm_uuid,
fzrt_int | which_state,
fz_string_td | str,
fzrt_boolean * | found )

Parameters

windex [Input]

project window index

srep_data [Input]

The data of Surface Style Representation.

parm_uuid [Input]

uuid of parameter

which_state [Input]

index of which state string of parameter to retrieve

str [Result]

string of the nth state (i.e. which_state) of the given parameter

found [Result]

TRUE, if the given uuid identified a parameter in this Surface Style Representation. FALSE otherwise.

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