form_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
11       int field_info(const FIELD *field,
12                      int *rows, int *cols,
13                      int *frow, int *fcol,
14                      int *nrow, int *nbuf);
15
16       int dynamic_field_info(const FIELD *field,
17                              int *rows, int *cols, int *max);
18

DESCRIPTION

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

RETURN VALUE

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

NOTES

46       The  header  file  <form.h>  automatically  includes  the  header  file
47       <curses.h>.
48

PORTABILITY

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

AUTHORS

58       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
59       Raymond.
60
61
62
63                                                           form_field_info(3X)