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

# fz_fuim_list_get_colm_title

Description

Gets the title of a column.
col_indx is the index to the column and must be greater than or equal to 0 and less than the number of columns in the list.
title_str must be preallocated to hold at least max_len number of characters.

Plugin Prototype

fzrt_error_td fz_fuim_list_get_colm_title(

fz_fuim_tmpl_ptr | fuim_tmpl,
fz_fuim_list_ptr | list_ptr,
fzrt_int | col_indx,
char * | title_str,
fzrt_int * | max_len )

Parameters

fuim_tmpl [Input]

fuim manager

list_ptr [Input]

list pointer

col_indx [Input]

column index

Range: 0 <= col_indx < number of columns

title_str [Result]

column title

max_len [Input, Optional]

the maximum length of the string to be returned. This cannot exceed the length that title_str was allocated to

Returns

Error codes

Availability

5.0.0.0

See Also

Function Set

fz_fuim_fset

Defined in

fz_fuim_list_api.h