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

# fz_fuim_item_encod_uchar

Description

Encodes a fuim item to an unsigned character.
The fuim item (such as a checkbox) will be 'on' if (*data_ptr & bit_mask == true_value), otherwise the fuim item will be 'off'.

Plugin Prototype

void fz_fuim_item_encod_uchar(

fz_fuim_tmpl_ptr | fuim_tmpl,
short | item_id,
unsigned char * | data_ptr,
fzrt_boolean | true_value,
unsigned char | bit_mask )

Parameters

fuim_tmpl [Input]

fuim manager

item_id [Input]

item id of fuim item to encode

data_ptr [Input]

pointer to the data to encode

true_value [Input]

if TRUE, the true value of the encoding agrees with the bit mask, otherwise the true value is when the bit mask doesn't find the value

bit_mask [Input]

bit mask of value to encode

Returns

None

Availability

5.0.0.0

See Also

fz_fuim_item_encod_bool,, fz_fuim_item_encod_short, fz_fuim_item_encod_ushort, fz_fuim_item_encod_int,

Function Set

fz_fuim_fset

Defined in

fz_fuim_api.h