xref: /illumos-gate/usr/src/man/man3curses/form_new.3curses (revision e8d80663e4f91871f843bb8ad9108dc0b76dfcf3)
te
Copyright 1989 AT&T
Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
FORM_NEW 3CURSES "Dec 31, 1996"
NAME
form_new, new_form, free_form - create and destroy forms
SYNOPSIS

cc [ flag... ] file... -lform  -lcurses  [ library... ]
#include <form.h>

FORM *new_form(FIELD **fields);

int free_form(FORM *form);
DESCRIPTION

new_form() creates a new form connected to the designated fields and returns a pointer to the form.

free_form() disconnects the form from its associated field pointer array and deallocates the space for the form.

RETURN VALUES

new_form() always returns NULL on error. free_form() returns one of the following: E_OK

The function returned successfully.

E_BAD_ARGUMENT

An argument is incorrect.

E_POSTED

The form is posted.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Unsafe
SEE ALSO

curses(3CURSES), forms(3CURSES), attributes(5)

NOTES

The header <form.h> automatically includes the headers <eti.h> and <curses.h>.