form_new.3x.html 5.0 KB

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