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

# fz_fuim_list_get_picked_func

Description

The list get picked status callback function.
This callback is designed to return whether a selected item is picked in the list.
This callback must be set in order for to work.
A structure should be maintained that has the picked status of each row.
When this callback is called, the picked status for the selected row should be passed back in picked.
row_indx is the index to the row item and will always be greater than or equal to 0 and less than the number of items in the list.
Note : Currently, the get picked callback will always be called with 0 for col_indx.

Plugin Prototype

fzrt_error_td fz_fuim_list_get_picked_func(

fz_fuim_tmpl_ptr | fuim_tmpl,
fz_fuim_list_ptr | list_ptr,
fzrt_int | row_indx,
fzrt_int | col_indx,
fzrt_boolean * | picked )

Parameters

fuim_tmpl [Input]

fuim manager

list_ptr [Input]

list pointer

row_indx [Input]

row index

col_indx [Input]

column index

picked [Result]

picked status
TRUE if picked, FALSE otherwise

Returns

Error codes

Availability

5.0.0.0

See Also

fz_fuim_list_set_get_picked_func,

Defined in

fz_fuim_list_api.h