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

form_field(3X)                                                form_field(3X)

NAME         top

       form_field - make and break connections between fields and forms

SYNOPSIS         top

       #include <form.h>
       int set_form_fields(FORM *form, FIELD **fields);
       FIELD **form_fields(const FORM *form);
       int field_count(const FORM *form);
       int move_field(FIELD *field, int frow, int fcol);

DESCRIPTION         top

       The function set_form_fields changes the field pointer array of the
       given form.  The array must be terminated by a NULL.

       The function form_fields returns the field array of the given form.

       The function field_count returns the count of fields in form.

       The function move_field moves the given field (which must be
       disconnected) to a specified location on the screen.

RETURN VALUE         top

       The function form_fields returns a pointer (which may be NULL).  It
       does not set errno.

       The function field_count returns ERR if the form parameter is NULL.

       The functions set_form_fields and move_field return one of the
       following codes on error:

       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_POSTED
            The form is already posted.

       E_SYSTEM_ERROR
            System error occurred (see errno).

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.

       The SVr4 forms library documentation specifies the field_count error
       value as -1 (which is the value of ERR).

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-05-03.  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_field(3X)