hiAddCyclicChoice

hiAddCyclicChoice( 
r_form 
s_cyclicField 
g_newChoice 
) 
=> t / nil

Description

Adds the new entry to the end of the list of choices in the cyclic field in the form.

To change the entire selection of a cyclic field, use

form->cyclicField->choices = newchoicelist

where newchoicelist is a list of strings and/or icons for this field. (See the description of hiCreateCyclicField for information on how to specify the list.)

Arguments

r_form	Form returned from hiCreateAppForm or hiCreateForm.
s_cyclicField	Must be a valid cyclic field in the specified form, and should be specified by its symbol handle within the form. If s_cyclicField is a shared field, g_newChoice is added to all occurrences of that field.
g_newChoice	The new entry to be added to the cyclicField contained in r_form. g_newChoice must either be text or an icon.

Values Returned

t	The new item is added.
nil	The new item is not added. An error message is returned.

Related Topics

hiCreateCyclicField

hiCreateAppForm

hiCreateForm

Form and Field Functions

Return to top