usr/src/man/man3curses/form_new.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH FORM_NEW 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 form_new, new_form, free_form \- create and destroy forms
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lform\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
  14 #include <form.h>
  15
  16 \fBFORM *\fR\fBnew_form\fR(\fBFIELD **\fR\fIfields\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint\fR \fBfree_form\fR(\fBFORM *\fR\fIform\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 \fBnew_form()\fR creates a new form connected to the designated fields and
  28 returns a pointer to the form.
  29 .sp
  30 .LP
  31 \fBfree_form()\fR disconnects the \fIform\fR from its associated field pointer
  32 array and deallocates the space for the form.
  33 .SH RETURN VALUES
  34 .sp
  35 .LP
  36 \fBnew_form()\fR always returns \fINULL\fR on error. \fBfree_form()\fR returns
  37 one of the following:
  38 .sp
  39 .ne 2
  40 .na
  41 \fBE_OK \fR
  42 .ad
  43 .RS 18n
  44 The function returned successfully.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fBE_BAD_ARGUMENT\fR
  51 .ad
  52 .RS 18n
  53 An argument is incorrect.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fBE_POSTED\fR
  60 .ad
  61 .RS 18n
  62 The form is posted.
  63 .RE
  64
  65 .SH ATTRIBUTES
  66 .sp
  67 .LP
  68 See \fBattributes\fR(5) for descriptions of the following attributes:
  69 .sp
  70
  71 .sp
  72 .TS
  73 box;
  74 c | c
  75 l | l .
  76 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  77 _
  78 MT-Level        Unsafe
  79 .TE
  80
  81 .SH SEE ALSO
  82 .sp
  83 .LP
  84 \fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5)
  85 .SH NOTES
  86 .sp
  87 .LP
  88 The header \fB<form.h>\fR automatically includes the headers  \fB<eti.h>\fR and
  89 \fB<curses.h>\fR\&.