ncurses 6.0 - patch 20170114
[ncurses.git] / doc / html / man / form_field_new.3x.html
index f6dd76a161ed79bb076fe349a58bc370f76879a7..b266a7e956b0fb904d26b92e9bc4e962cf57ec26 100644 (file)
@@ -1,16 +1,58 @@
+<!-- 
+  * t
+  ****************************************************************************
+  * Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
+  *                                                                          *
+  * Permission is hereby granted, free of charge, to any person obtaining a  *
+  * copy of this software and associated documentation files (the            *
+  * "Software"), to deal in the Software without restriction, including      *
+  * without limitation the rights to use, copy, modify, merge, publish,      *
+  * distribute, distribute with modifications, sublicense, and/or sell       *
+  * copies of the Software, and to permit persons to whom the Software is    *
+  * furnished to do so, subject to the following conditions:                 *
+  *                                                                          *
+  * The above copyright notice and this permission notice shall be included  *
+  * in all copies or substantial portions of the Software.                   *
+  *                                                                          *
+  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
+  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
+  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
+  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
+  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
+  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
+  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
+  *                                                                          *
+  * Except as contained in this notice, the name(s) of the above copyright   *
+  * holders shall not be used in advertising or otherwise to promote the     *
+  * sale, use or other dealings in this Software without prior written       *
+  * authorization.                                                           *
+  ****************************************************************************
+  * @Id: form_field_new.3x,v 1.19 2015/12/05 23:42:45 tom Exp @
+-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HTML>
+<HEAD>
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
+<TITLE>form_field_new 3x</TITLE>
+<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
 <BODY>
 <BODY>
+<H1 class="no-header">form_field_new 3x</H1>
 <PRE>
 <PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>                                   <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
 
 
-</PRE>
-<H2>NAME</H2><PRE>
-       <B>form_field_new</B> - create and destroy form fields
 
 
 
 
-</PRE>
-<H2>SYNOPSIS</H2><PRE>
-       <B>#include</B> <B>&lt;form.h&gt;</B>
+
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+       <STRONG>new_field</STRONG>,  <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG>, <STRONG>free_field</STRONG> - create and
+       destroy form fields
+
+
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
+       <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
        FIELD *new_field(int height, int width,
                         int toprow, int leftcol,
                         int offscreen, int nbuffers);
        FIELD *new_field(int height, int width,
                         int toprow, int leftcol,
                         int offscreen, int nbuffers);
        int free_field(FIELD *field);
 
 
        int free_field(FIELD *field);
 
 
-</PRE>
-<H2>DESCRIPTION</H2><PRE>
-       The  function <B>new_field</B> allocates a new field and initial-
-       izes it from the parameters given: height, width,  row  of
-       upper-left  corner,  column  of  upper-left corner, number
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
+       The function <STRONG>new_field</STRONG> allocates a new field and  initial-
+       izes  it  from the parameters given: height, width, row of
+       upper-left corner, column  of  upper-left  corner,  number
        off-screen rows, and number of additional working buffers.
 
        off-screen rows, and number of additional working buffers.
 
-       The  function  <B>dup_field</B> duplicates a field at a new loca-
+       The  function  <STRONG>dup_field</STRONG> duplicates a field at a new loca-
        tion.  Most attributes (including current contents,  size,
        validation  type, buffer count, growth threshold, justifi-
        cation, foreground, background,  pad  character,  options,
        and  user pointer) are copied.  Field status and the field
        page bit are not copied.
 
        tion.  Most attributes (including current contents,  size,
        validation  type, buffer count, growth threshold, justifi-
        cation, foreground, background,  pad  character,  options,
        and  user pointer) are copied.  Field status and the field
        page bit are not copied.
 
-       The function <B>link_field</B> acts like <B>dup_field</B>, but  the  new
+       The function <STRONG>link_field</STRONG> acts like <STRONG>dup_field</STRONG>, but  the  new
        field  shares  buffers with its parent.  Attribute data is
        separate.
 
        field  shares  buffers with its parent.  Attribute data is
        separate.
 
-       The function <B>free_field</B>  de-allocates  storage  associated
+       The function <STRONG>free_field</STRONG>  de-allocates  storage  associated
        with a field.
 
 
        with a field.
 
 
-</PRE>
-<H2>RETURN VALUE</H2><PRE>
-       The function, <B>new_field</B>, <B>dup_field</B>, <B>link_field</B> return <B>NULL</B>
-       on error.
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+       The function, <STRONG>new_field</STRONG>, <STRONG>dup_field</STRONG>, <STRONG>link_field</STRONG> return <STRONG>NULL</STRONG>
+       on error.  They set errno according to their success:
 
 
-       The function <B>free_field</B> returns one of the following:
+       <STRONG>E_OK</STRONG> The routine succeeded.
 
 
-       <B>E_OK</B> The routine succeeded.
-
-       <B>E_SYSTEM_ERROR</B>
-            System error occurred (see <B>errno</B>).
-
-       <B>E_BAD_ARGUMENT</B>
+       <STRONG>E_BAD_ARGUMENT</STRONG>
             Routine detected an incorrect or  out-of-range  argu-
             ment.
 
             Routine detected an incorrect or  out-of-range  argu-
             ment.
 
+       <STRONG>E_SYSTEM_ERROR</STRONG>
+            System error occurred, e.g., malloc failure.
 
 
-</PRE>
-<H2>SEE ALSO</H2><PRE>
-       <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>.
-
-
-</PRE>
-<H2>NOTES</H2><PRE>
-       The header file <B>&lt;form.h&gt;</B> automatically includes the header
-       file <B>&lt;curses.h&gt;</B>.
-
-
-</PRE>
-<H2>PORTABILITY</H2><PRE>
-       These routines emulate the System V forms  library.   They
-       were not supported on Version 7 or BSD versions.
-
-       It  may be unwise to count on the set of attributes copied
-       by  <B><A HREF="dup_field.3x.html">dup_field(3x)</A></B>  being  portable;  the  System  V  forms
-       library  documents  are  not  very  explicit  on what gets
-       copied and was not.
-
-
-</PRE>
-<H2>AUTHORS</H2><PRE>
-       Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
-       curses by Eric S. Raymond.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+       The function <STRONG>free_field</STRONG> returns one of the following:
 
 
+       <STRONG>E_OK</STRONG> The routine succeeded.
 
 
+       <STRONG>E_BAD_ARGUMENT</STRONG>
+            Routine  detected  an incorrect or out-of-range argu-
+            ment.
 
 
+       <STRONG>E_CONNECTED</STRONG>
+            field is connected.
 
 
 
 
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
 
 
 
 
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+       The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
+       file <STRONG>&lt;curses.h&gt;</STRONG>.
 
 
 
 
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+       These  routines  emulate the System V forms library.  They
+       were not supported on Version 7 or BSD versions.
 
 
+       It may be unwise to count on the set of attributes  copied
+       by  <STRONG>dup_field</STRONG>  being  portable; the System V forms library
+       documents are not very explicit about what gets copied and
+       what does not.
 
 
 
 
+</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
+       Juergen  Pfeifer.   Manual  pages  and  adaptation for new
+       curses by Eric S. Raymond.
 
 
 
 
 
 
+                                                     <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
 </PRE>
 </PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-AUTHORS">AUTHORS</a></li>
+</ul>
+</div>
 </BODY>
 </HTML>
 </BODY>
 </HTML>