form_field(3x)

1form_field(3X)                                                  form_field(3X)
2
3
4

NAME

6       form_field - make and break connections between fields and forms
7

SYNOPSIS

9       #include <form.h>
10       int set_form_fields(FORM *form, FIELD **fields);
11       FIELD **form_fields(const FORM *form);
12       int field_count(const FORM *form);
13       int move_field(FIELD *field, int frow, int fcol);
14

DESCRIPTION

16       The  function  set_form_fields  changes  the field pointer array of the
17       given form.  The array must be terminated by a NULL.
18
19       The function form_fields returns the field array of the given form.
20
21       The function field_count returns the count of fields in form.
22
23       The function move_field moves the given field (which  must  be  discon‐
24       nected) to a specified location on the screen.
25

RETURN VALUE

27       The  function  form_fields  returns  a pointer (which may be NULL).  It
28       does not set errno.
29
30       The function field_count returns ERR if the form parameter is NULL.
31
32       The functions set_form_fields and move_field return one of the  follow‐
33       ing codes on error:
34
35       E_OK The routine succeeded.
36
37       E_BAD_ARGUMENT
38            Routine detected an incorrect or out-of-range argument.
39
40       E_CONNECTED
41            The field is already connected to a form.
42
43       E_POSTED
44            The form is already posted.
45
46       E_SYSTEM_ERROR
47            System error occurred (see errno(3)).
48

NOTES

53       The  header  file  <form.h>  automatically  includes  the  header  file
54       <curses.h>.
55

PORTABILITY

57       These routines emulate the System V forms library.  They were not  sup‐
58       ported on Version 7 or BSD versions.
59
60       The  SVr4  forms  library documentation specifies the field_count error
61       value as -1 (which is the value of ERR).
62

AUTHORS

64       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
65       Raymond.
66
67
68
69                                                                form_field(3X)