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

# fz_fuim_list_get_picked_status

Description

Retrieves the picked status of the specified row.
This function is different from the get picked callback function. This function will retrieve the picked status of the item from the status stored in the list as opposed to the callback which requires an externally maintained pick status. 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.
col_indx is currently ignored.
The picked status for the selected row will be passed back in picked.

Plugin Prototype

fzrt_error_td fz_fuim_list_get_picked_status(

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

Range: 0 <= row_indx < number of items in list

col_indx [Input]

column index

picked [Result]

picked status
TRUE if picked, FALSE otherwise

Returns

Error codes

Availability

5.0.0.0

Function Set

fz_fuim_fset

Defined in

fz_fuim_list_api.h