formZ SDK | 5.0 API Reference | System | User Interface (FUIM) | Templates

# fz_fuim_item_cust_func

Description

This function is called to handle events that happen to a custom item.
It is passed in the cust_func parameter of fz_fuim_new_custom when creating a new custom item. It can also be is passed in the func parameter of when setting a custom function of an already created custom item.
Not all action types have to be handled in the function.

Plugin Prototype

short fz_fuim_item_cust_func(

fz_fuim_tmpl_ptr | fuim_tmpl,
short | indx,
fz_fuim_actn_cust_enum | action,
fz_type_td * | action_data,
void * | func_data,
void ** | prvt_data )

Parameters

fuim_tmpl [Input]

fuim manager

indx [Input]

item id of custom item that an action occurred on

action [Input]

type of action that occurred

action_data [Input, Result]

data passed to be used by the action

func_data [Input]

data to pass to the custom item function

prvt_data [Result]

data that is created by the custom function for return

Returns

TRUE if the action was handled successfully, FALSE if it was not successful.

Availability

5.0.0.0

See Also

fz_fuim_new_custom,

Defined in

fz_fuim_api.h