field_info(3x)

1form_field_info(3X)                                        form_field_info(3X)
2
3
4

NAME

6       dynamic_field_info, field_info - retrieve field characteristics
7

SYNOPSIS

9       #include <form.h>
10       int field_info(const FIELD *field, int *rows, int *cols,
11                     int *frow, int *fcol, int *nrow, int *nbuf);
12       int  dynamic_field_info(const  FIELD  *field, int *rows, int *cols, int
13       *max);
14

DESCRIPTION

16       The function field_info returns the sizes and other  attributes  passed
17       in  to  the  field  at  its creation time.  The attributes are: height,
18       width, row of upper-left corner, column of  upper-left  corner,  number
19       off-screen rows, and number of working buffers.
20
21       The  function  dynamic_field_info returns the actual size of the field,
22       and its maximum possible size.  If the field has  no  size  limit,  the
23       location addressed by the third argument will be set to 0.  A field can
24       be made dynamic by turning off the O_STATIC option with field_opts_off.
25

RETURN VALUE

27       These routines return one of the following:
28
29       E_OK The routine succeeded.
30
31       E_SYSTEM_ERROR
32            System error occurred (see errno).
33
34       E_BAD_ARGUMENT
35            Routine detected an incorrect or out-of-range argument.
36

NOTES

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

PORTABILITY

46       These routines emulate the System V forms library.  They were not  sup‐
47       ported on Version 7 or BSD versions.
48
49       A  null  (zero  pointer)  is  accepted for any of the return values, to
50       ignore that value.  Not all implementations allow this,  e.g.,  Solaris
51       2.7 does not.
52

AUTHORS

54       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
55       Raymond.
56
57
58
59                                                           form_field_info(3X)