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
11       int set_form_fields(FORM *form, FIELD **fields);
12       FIELD **form_fields(const FORM *form);
13       int field_count(const FORM *form);
14       int move_field(FIELD *field, int frow, int fcol);
15

DESCRIPTION

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

RETURN VALUE

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

NOTES

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

PORTABILITY

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

AUTHORS

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