hiDeleteForm

hiDeleteForm( 
r_form 
) 
=> t / nil

Description

Deletes the form specified and any fields the form contains.

The global SKILL handle representing this form is reset to nil. Users should not programmatically reset a form SKILL handle to nil. This function should not be called within the callback routine of form, or if the form is currently being displayed. Users should take care to delete any unnecessary forms. This routine returns t if the form was deleted successfully; otherwise, if this function was called from within the callback procedure, or the form is still displayed on the screen, nil is returned.

Argument

r_form

Form to be deleted. It must be a valid form description returned from hiCreateAppForm, hiCreateForm, or hiCreateOptionsForm.

Value Returned

t	The form is deleted.
nil	An error occurred.

Related Topics

Form and Field Functions

Return to top