1<!-- 2 **************************************************************************** 3 * Copyright 2018-2023,2024 Thomas E. Dickey * 4 * Copyright 1998-2010,2015 Free Software Foundation, Inc. * 5 * * 6 * Permission is hereby granted, free of charge, to any person obtaining a * 7 * copy of this software and associated documentation files (the * 8 * "Software"), to deal in the Software without restriction, including * 9 * without limitation the rights to use, copy, modify, merge, publish, * 10 * distribute, distribute with modifications, sublicense, and/or sell * 11 * copies of the Software, and to permit persons to whom the Software is * 12 * furnished to do so, subject to the following conditions: * 13 * * 14 * The above copyright notice and this permission notice shall be included * 15 * in all copies or substantial portions of the Software. * 16 * * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * 18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * 19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * 20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * 21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * 22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * 23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * 24 * * 25 * Except as contained in this notice, the name(s) of the above copyright * 26 * holders shall not be used in advertising or otherwise to promote the * 27 * sale, use or other dealings in this Software without prior written * 28 * authorization. * 29 **************************************************************************** 30 * @Id: form_new.3x,v 1.32 2024/03/16 15:35:01 tom Exp @ 31--> 32<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> 33<HTML> 34<HEAD> 35<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> 36<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> 37<TITLE>form_new 3x 2024-03-16 ncurses 6.5 Library calls</TITLE> 38<link rel="author" href="mailto:bug-ncurses@gnu.org"> 39 40</HEAD> 41<BODY> 42<H1 class="no-header">form_new 3x 2024-03-16 ncurses 6.5 Library calls</H1> 43<PRE> 44<STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG> Library calls <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG> 45 46 47 48 49</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> 50 <STRONG>new_form</STRONG>, <STRONG>free_form</STRONG> - create and destroy forms 51 52 53</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> 54 <STRONG>#include</STRONG> <STRONG><form.h></STRONG> 55 56 <STRONG>FORM</STRONG> <STRONG>*new_form(FIELD</STRONG> <STRONG>**</STRONG><EM>fields</EM><STRONG>);</STRONG> 57 <STRONG>int</STRONG> <STRONG>free_form(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG> 58 59 60</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> 61 The function <STRONG>new_form</STRONG> creates a new form connected to a specified field 62 pointer array (which must be <STRONG>NULL</STRONG>-terminated). 63 64 The function <STRONG>free_form</STRONG> disconnects <EM>form</EM> from its field array and frees 65 the storage allocated for the form. 66 67 68</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> 69 The function <STRONG>new_form</STRONG> returns <STRONG>NULL</STRONG> on error. It sets <STRONG>errno</STRONG> according 70 to the function's success: 71 72 <STRONG>E_OK</STRONG> The routine succeeded. 73 74 <STRONG>E_BAD_ARGUMENT</STRONG> 75 Routine detected an incorrect or out-of-range argument. 76 77 <STRONG>E_CONNECTED</STRONG> 78 The field is already connected to a form. 79 80 <STRONG>E_SYSTEM_ERROR</STRONG> 81 System error occurred, e.g., malloc failure. 82 83 The function <STRONG>free_form</STRONG> returns one of the following: 84 85 <STRONG>E_OK</STRONG> The routine succeeded. 86 87 <STRONG>E_BAD_ARGUMENT</STRONG> 88 Routine detected an incorrect or out-of-range argument. 89 90 <STRONG>E_POSTED</STRONG> 91 The form has already been posted. 92 93 94</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> 95 These routines emulate the System V forms library. They were not 96 supported on Version 7 or BSD versions. 97 98 99</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> 100 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. 101 Raymond. 102 103 104</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> 105 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG> 106 107 108 109ncurses 6.5 2024-03-16 <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG> 110</PRE> 111<div class="nav"> 112<ul> 113<li><a href="#h2-NAME">NAME</a></li> 114<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> 115<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> 116<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> 117<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> 118<li><a href="#h2-AUTHORS">AUTHORS</a></li> 119<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> 120</ul> 121</div> 122</BODY> 123</HTML> 124