dwww Home | Manual pages | Find package

field_info(3FORM)                Library calls                field_info(3FORM)

NAME
       dynamic_field_info, field_info - retrieve field characteristics

SYNOPSIS
       #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
       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 lo-
       cation 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
       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.

PORTABILITY
       These routines emulate the System V forms library.  They were  not  sup-
       ported on Version 7 or BSD versions.

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

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

SEE ALSO
       ncurses(3NCURSES) and related pages whose names begin  “form_”  for  de-
       tailed descriptions of the entry points.

ncurses 6.5                        2024-03-16                 field_info(3FORM)

Generated by dwww version 1.16 on Sat Oct 3 06:49:46 CEST 2026.