carta
free_form(3form)

free_form3form

Create and destroy forms

Part of new(3form).

Usage

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.

Portability

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

History

  • Debian 13 (Trixie): the text shown here
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)
  • Debian 9 (Stretch)
  • Debian 8 (Jessie) to Debian 7 (Wheezy)
  • Debian 6.0 (Squeeze) to Debian 5.0 (Lenny)
  • Debian 4.0 (Etch)
  • Debian 3.1 (Sarge)
  • Debian 3.0 (Woody)

Authors

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

From ncurses-doc 6.5+20250216-2 in Debian 13 (Trixie). Parsed by carta from the page's man source.