formfieldinfo(3X) formfieldinfo(3X)

NAME
       ffoorrmmffiieellddiinnffoo - retrieve field characteristics

SYNOPSIS
       ##iinncclluuddee <>
       int fieldinfo(const FIELD *field, int *rows, int *cols,
                     int *frow, int *fcol, int *nrow, int *nbuf);
       int  dynamicfieldinfo(const  FIELD  *field, int *rows, int *cols, int
       *max);

DESCRIPTION
       The function ffiieellddiinnffoo 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  ddyynnaammiiccffiieellddiinnffoo 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 OOSSTTAATTIICC option with ffiieellddooppttssooffff.

RREETTUURRNN VVAALLUUEE
       These routines return one of the following:

       EEOOKK The routine succeeded.

       EESSYYSSTTEEMMEERRRROORR
            System error occurred (see eerrrrnnoo).

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

SEE ALSO
       ccuurrsseess(3X)  and  related  pages  whose names begin "form" for detailed
       descriptions of the entry points.

NNOOTTEESS
       The  header  file  <>  automatically  includes  the  header  file
       <>.

PPOORRTTAABBIILLIITTYY
       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
       ignore  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.



                                                           formfieldinfo(3X)