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
12       FIELD *new_field(int height, int width,
13                        int toprow, int leftcol,
14                        int offscreen, int nbuffers);
15       FIELD *dup_field(FIELD *field, int toprow, int leftcol);
16       FIELD *link_field(FIELD *field, int toprow, int leftcol);
17       int free_field(FIELD *field);
18

DESCRIPTION

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

RETURN VALUE

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

SEE ALSO

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

NOTES

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

PORTABILITY

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

AUTHORS

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