lib/libform/form_new.3

   1 .\"     $NetBSD: form_new.3,v 1.9 2010/03/22 21:58:31 joerg Exp $
   2 .\"
   3 .\" Copyright (c) 2001
   4 .\"     Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
   5 .\"
   6 .\" This code is donated to The NetBSD Foundation by the author.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. The name of the Author may not be used to endorse or promote
  17 .\"    products derived from this software without specific prior written
  18 .\"    permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .Dd January 1, 2001
  33 .Dt FORMS 3
  34 .Os
  35 .Sh NAME
  36 .Nm free_form ,
  37 .Nm new_form
  38 .Nd form library
  39 .Sh LIBRARY
  40 .Lb libform
  41 .Sh SYNOPSIS
  42 .In form.h
  43 .Ft int
  44 .Fn free_form "FORM *form"
  45 .Ft FORM *
  46 .Fn new_form "FIELD **fields"
  47 .Sh DESCRIPTION
  48 The function
  49 .Fn free_form
  50 frees all the resources associated with the form and destroys the
  51 form.
  52 Calling
  53 .Fn new_form
  54 will create a new form, set the form parameters to the current
  55 defaults and attach the passed fields to the form.
  56 The array of fields passed to
  57 .Fn new_form
  58 must be terminated with a
  59 .Dv NULL
  60 pointer to indicate the end of the fields.
  61 .Sh RETURN VALUES
  62 Functions returning pointers will return
  63 .Dv NULL
  64 if an error is detected.
  65 The functions that return an int will return one of the following error
  66 values:
  67 .Pp
  68 .Bl -tag -width E_UNKNOWN_COMMAND -compact
  69 .It Er E_OK
  70 The function was successful.
  71 .It Er E_BAD_ARGUMENT
  72 The function was passed a bad argument.
  73 .It Er E_POSTED
  74 The form is posted to the screen.
  75 .El
  76 .Sh SEE ALSO
  77 .Xr curses 3 ,
  78 .Xr forms 3
  79 .Sh NOTES
  80 The header
  81 .In form.h
  82 automatically includes both
  83 .In curses.h
  84 and
  85 .In eti.h .