doc/html/man/form_post.3x.html

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
   2 <!--
   3   * t
   4   ****************************************************************************
   5   * Copyright (c) 1998 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_post.3x,v 1.4 1998/11/29 01:08:10 Rick.Ohnemus Exp @
  32 -->
  33 <HTML>
  34 <HEAD>
  35 <TITLE>form_post 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_post 3x</H1>
  41 <HR>
  42 <PRE>
  43 <!-- Manpage converted by man2html 3.0.1 -->
  44
  45 </PRE>
  46 <H2>NAME</H2><PRE>
  47        <STRONG>form_post</STRONG>  -  write or erase forms from associated subwin-
  48        dows
  49
  50
  51 </PRE>
  52 <H2>SYNOPSIS</H2><PRE>
  53        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
  54        int post_form(FORM *form);
  55        int unpost_form(FORM *form);
  56
  57
  58 </PRE>
  59 <H2>DESCRIPTION</H2><PRE>
  60        The function <STRONG>post_form</STRONG> displays a form to  its  associated
  61        subwindow.   To trigger physical display of the subwindow,
  62        use  <STRONG>refresh</STRONG>  or  some  equivalent  <STRONG>curses</STRONG>  routine   (the
  63        implicit  <STRONG>doupdate</STRONG>  triggered  by  an <STRONG>curses</STRONG> input request
  64        will do).
  65
  66        The function <STRONG>unpost_form</STRONG> erases form from  its  associated
  67        subwindow.
  68
  69
  70 </PRE>
  71 <H2>RETURN VALUE</H2><PRE>
  72        These routines return one of the following:
  73
  74        <STRONG>E_OK</STRONG> The routine succeeded.
  75
  76        <STRONG>E_SYSTEM_ERROR</STRONG>
  77             System error occurred (see <STRONG>errno</STRONG>).
  78
  79        <STRONG>E_BAD_ARGUMENT</STRONG>
  80             Routine  detected  an incorrect or out-of-range argu-
  81             ment.
  82
  83        <STRONG>E_POSTED</STRONG>
  84             The form has already been posted.
  85
  86        <STRONG>E_BAD_STATE</STRONG>
  87             Routine was called from an initialization or termina-
  88             tion function.
  89
  90        <STRONG>E_NO_ROOM</STRONG>
  91             Form is too large for its window.
  92
  93        <STRONG>E_NOT_POSTED</STRONG>
  94             The form has not been posted.
  95
  96        <STRONG>E_NOT_CONNECTED</STRONG>
  97             No items are connected to the form.
  98
  99
 100 </PRE>
 101 <H2>SEE ALSO</H2><PRE>
 102        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
 103
 104
 105 </PRE>
 106 <H2>NOTES</H2><PRE>
 107        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
 108        file <STRONG>&lt;curses.h&gt;</STRONG>.
 109
 110
 111 </PRE>
 112 <H2>PORTABILITY</H2><PRE>
 113        These routines emulate the System V forms  library.   They
 114        were not supported on Version 7 or BSD versions.
 115
 116
 117 </PRE>
 118 <H2>AUTHORS</H2><PRE>
 119        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
 120        curses by Eric S. Raymond.
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168 </PRE>
 169 <HR>
 170 <ADDRESS>
 171 Man(1) output converted with
 172 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 173 </ADDRESS>
 174 </BODY>
 175 </HTML>