form_new(3form)

form_new3form

Create and destroy forms

Part of new(3form).

Usage

#include <form.h>
FORM *new_form(FIELD **fields);
int free_form(FORM *form);

Overview

The function new_form creates a new form connected to a specified field pointer array (which must be NULL-terminated).

The function free_form disconnects form from its field array and frees the storage allocated for the form.

Return value

The function new_form returns NULL on error. It sets errno according to the function's success:

E_OK

The routine succeeded.

E_BAD_ARGUMENT

Routine detected an incorrect or out-of-range argument.

E_CONNECTED

The field is already connected to a form.

E_SYSTEM_ERROR

System error occurred, e.g., malloc failure.

The function free_form returns one of the following:

E_OK

The routine succeeded.

E_BAD_ARGUMENT

Routine detected an incorrect or out-of-range argument.

E_POSTED

The form has already been posted.

Notes

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

Portability

These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions.

Releases

7 releases since Debian 3.0 (Woody); the text changed 4 times.

  1. 3.0
  2. 3.1
  3. 4.0
  4. 5.0–6.0
  5. 7–8

Authors

Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.

From ncurses-doc 5.9+20140913-1+deb8u3 in Debian 8 (Jessie). Parsed by carta from the page's man source.