1form_field_new(3X)                                          form_field_new(3X)
2
3
4

NAME

6       new_field,  dup_field, link_field, free_field - create and destroy form
7       fields
8

SYNOPSIS

10       #include <form.h>
11       FIELD *new_field(int height, int width,
12                        int toprow, int leftcol,
13                        int offscreen, int nbuffers);
14       FIELD *dup_field(FIELD *field, int toprow, int leftcol);
15       FIELD *link_field(FIELD *field, int toprow, int leftcol);
16       int free_field(FIELD *field);
17

DESCRIPTION

19       The function new_field allocates a new field and  initializes  it  from
20       the  parameters  given: height, width, row of upper-left corner, column
21       of upper-left corner, number off-screen rows, and number of  additional
22       working buffers.
23
24       The  function  dup_field  duplicates  a  field at a new location.  Most
25       attributes (including current contents, size, validation  type,  buffer
26       count,  growth  threshold,  justification,  foreground, background, pad
27       character, options, and user pointer) are copied.  Field status and the
28       field page bit are not copied.
29
30       The  function  link_field acts like dup_field, but the new field shares
31       buffers with its parent.  Attribute data is separate.
32
33       The function free_field de-allocates storage associated with a field.
34

RETURN VALUE

36       The function, new_field, dup_field, link_field return  NULL  on  error.
37       They set errno according to their success:
38
39       E_OK The routine succeeded.
40
41       E_BAD_ARGUMENT
42            Routine detected an incorrect or out-of-range argument.
43
44       E_SYSTEM_ERROR
45            System error occurred, e.g., malloc failure.
46
47       The function free_field returns one of the following:
48
49       E_OK The routine succeeded.
50
51       E_BAD_ARGUMENT
52            Routine detected an incorrect or out-of-range argument.
53
54       E_CONNECTED
55            field is connected.
56

SEE ALSO

58       curses(3X), form(3X).
59

NOTES

61       The  header  file  <form.h>  automatically  includes  the  header  file
62       <curses.h>.
63

PORTABILITY

65       These routines emulate the System V forms library.  They were not  sup‐
66       ported on Version 7 or BSD versions.
67
68       It  may be unwise to count on the set of attributes copied by dup_field
69       being portable; the System V  forms  library  documents  are  not  very
70       explicit about what gets copied and what does not.
71

AUTHORS

73       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
74       Raymond.
75
76
77
78                                                            form_field_new(3X)
Impressum