#include<form.h>
FIELD *new_field(int height, int width,
int toprow, int leftcol,
@@ -62,80 +62,84 @@
int free_field(FIELD *field);
-
-
DESCRIPTION
- The function new_field allocates a new field and initial-
- izes it from the parameters given: height, width, row of
- upper-left corner, column of upper-left corner, number
- off-screen rows, and number of additional working buffers.
+
+ The function new_field allocates a new field and initializes it from
+ the parameters given: height, width, row of upper-left corner, column
+ of upper-left corner, number off-screen rows, and number of additional
+ working buffers.
- The function dup_field duplicates a field at a new loca-
- tion. Most attributes (including current contents, size,
- validation type, buffer count, growth threshold, justifi-
- cation, foreground, background, pad character, options,
- and user pointer) are copied. Field status and the field
- page bit are not copied.
+ The function dup_field duplicates a field at a new location. Most
+ attributes (including current contents, size, validation type, buffer
+ count, growth threshold, justification, foreground, background, pad
+ character, options, and user pointer) are copied. Field status and the
+ field page bit are not copied.
- The function link_field acts like dup_field, but the new
- field shares buffers with its parent. Attribute data is
- separate.
+ The function link_field acts like dup_field, but the new field shares
+ buffers with its parent. Attribute data is separate.
- The function free_field de-allocates storage associated
- with a field.
+ The function free_field de-allocates storage associated with a field.
-
-
RETURN VALUE
- The function, new_field, dup_field, link_field return NULL
- on error.
-
- The function free_field returns one of the following:
+
+ The functions new_field, dup_field, link_field return NULL on error.
+ They set errno according to their success:
E_OK The routine succeeded.
+ E_BAD_ARGUMENT
+ Routine detected an incorrect or out-of-range argument.
+
E_SYSTEM_ERROR
- System error occurred (see errno).
+ System error occurred, e.g., malloc failure.
+
+ The function free_field returns one of the following:
+
+ E_OK The routine succeeded.
E_BAD_ARGUMENT
- Routine detected an incorrect or out-of-range argu-
- ment.
+ Routine detected an incorrect or out-of-range argument.
+ E_CONNECTED
+ field is connected.
-
+ These routines emulate the System V forms library. They were not sup-
+ ported on Version 7 or BSD versions.
- It may be unwise to count on the set of attributes copied
- by dup_field(3x) being portable; the System V forms
- library documents are not very explicit about what gets
- copied and what doesn't.
+ It may be unwise to count on the set of attributes copied by dup_field
+ being portable; the System V forms library documents are not very
+ explicit about what gets copied and what does not.
-
-
AUTHORS
- Juergen Pfeifer. Manual pages and adaptation for new
- curses by Eric S. Raymond.
+