formZ SDK | 4.0 Call Back Reference | Object Type

# fz_otyp_cbak_parm_get_state_str

Description

Object type 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_otyp_cbak_parm_get_state_str(

fzrt_UUID_td | parm_uuid,
fzrt_int | which_state,
fz_string_td | str )

Parameters

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 of the given parameter

Returns

Error codes

Availability

6.0.0.0

See Also

fz_otyp_cbak_parm_get_info, fz_otyp_cbak_parm_get, fz_otyp_cbak_parm_set,

Function Set

fz_otyp_cbak_fset

Defined in

fz_otyp_api.h