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

# fz_fuim_list_get_string_func

Description

The list get string callback function.
This callback is designed to return the string in a specified row and column of a list.
The draw item callback function is called before this.
Both the draw item function and the get string function can be called for the same item. If both functions exist for an item, the draw item is handled first followed by the get string. In this case, the text will be drawn on top of the item.
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 the index to the column and will always be greater than or equal to 0 and less than the number of columns in the list.
max_len is the maximum length of str and str must not exceed max_len.
Return whether a string was found in did.
Strings in the title row are not handled by this callback but are instead retrieved by calling .

Plugin Prototype

fzrt_error_td fz_fuim_list_get_string_func(

fz_fuim_tmpl_ptr | fuim_tmpl,
fz_fuim_list_ptr | list_ptr,
fzrt_int | row_indx,
fzrt_int | col_indx,
char * | str,
fzrt_int | max_len,
fzrt_boolean * | did )

Parameters

fuim_tmpl [Input]

fuim manager

list_ptr [Input]

list pointer

row_indx [Input]

row index

col_indx [Input]

column index

str [Result]

string

max_len [Input]

maximum length of string

did [Result]

was a string found
TRUE if string was found, FALSE otherwise

Returns

Error codes

Availability

5.0.0.0

See Also

,

Defined in

fz_fuim_list_api.h