form_field_info(3x) — Linux manual page

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

form_field_info(3X)                                  form_field_info(3X)

NAME         top

       dynamic_field_info, field_info - retrieve field characteristics

SYNOPSIS         top

       #include <form.h>

       int field_info(const FIELD *field,
                      int *rows, int *cols,
                      int *frow, int *fcol,
                      int *nrow, int *nbuf);

       int dynamic_field_info(const FIELD *field,
                              int *rows, int *cols, int *max);

DESCRIPTION         top

       The function field_info returns the sizes and other attributes
       passed in to the field at its creation time.  The attributes are:
       height, width, row of upper-left corner, column of upper-left
       corner, number off-screen rows, and number of working buffers.

       The function dynamic_field_info returns the actual size of the
       field, and its maximum possible size.  If the field has no size
       limit, the location addressed by the third argument will be set
       to 0.  A field can be made dynamic by turning off the O_STATIC
       option with field_opts_off.

RETURN VALUE         top

       These routines return one of the following:

       E_OK The routine succeeded.

       E_SYSTEM_ERROR
            System error occurred (see errno(3)).

       E_BAD_ARGUMENT
            Routine detected an incorrect or out-of-range argument.

SEE ALSO         top

       curses(3X) and related pages whose names begin “form_” for
       detailed descriptions of the entry points.

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.

       A null (zero pointer) is accepted for any of the return values,
       to ignore that value.  Not all implementations allow this, e.g.,
       Solaris 2.7 does not.

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 2021-06-20.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2021-05-23.)  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_info(3X)