NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | NOTES | PORTABILITY | AUTHORS | COLOPHON

form_new(3X)                                                    form_new(3X)

NAME         top

       new_form, free_form - create and destroy forms

SYNOPSIS         top

       #include <form.h>
       FORM *new_form(FIELD **fields);
       int free_form(FORM *form);

DESCRIPTION         top

       The function new_form creates a new form connected to a specified
       field pointer array (which must be NULL-terminated).
       The function free_form disconnects form from its field array and
       frees the storage allocated for the form.

RETURN VALUE         top

       The function new_form returns NULL on error.  It sets errno according
       to the function's success:
       E_OK The routine succeeded.
       E_BAD_ARGUMENT
            Routine detected an incorrect or out-of-range argument.
       E_CONNECTED
            The field is already connected to a form.
       E_SYSTEM_ERROR
            System error occurred, e.g., malloc failure.
       The function free_form returns one of the following:
       E_OK The routine succeeded.
       E_BAD_ARGUMENT
            Routine detected an incorrect or out-of-range argument.
       E_POSTED
            The form has already been posted.

SEE ALSO         top

       curses(3X), form(3X).

NOTES         top

       The header file <form.h> automatically includes the header file
       <curses.h>.

PORTABILITY         top

       These routines emulate the System V forms library.  They were not
       supported on Version 7 or BSD versions.

AUTHORS         top

       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
       S. Raymond.

COLOPHON         top

       This page is part of the ncurses (new curses) project.  Information
       about the project can be found at 
       ⟨https://www.gnu.org/software/ncurses/ncurses.html⟩.  If you have a
       bug report for this manual page, send it to
       bug-ncurses-request@gnu.org.  This page was obtained from the
       project's upstream Git mirror of the CVS repository 
       ⟨git://ncurses.scripts.mit.edu/ncurses.git⟩ on 2017-07-05.  If you
       discover any rendering problems in this HTML version of the page, or
       you believe there is a better or more up-to-date source for the page,
       or you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a mail
       to man-pages@man7.org
                                                                form_new(3X)