ncurses 6.1 - patch 20190121
[ncurses.git] / doc / html / man / form_cursor.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2018,2019 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_cursor.3x,v 1.11 2019/01/20 20:31:42 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_cursor 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">form_cursor 3x</H1>
43 <PRE>
44 <STRONG><A HREF="form_cursor.3x.html">form_cursor(3x)</A></STRONG>                                                <STRONG><A HREF="form_cursor.3x.html">form_cursor(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>pos_form_cursor</STRONG> - position a form window cursor
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
55        int pos_form_cursor(FORM *form);
56
57
58 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
59        The  function  <STRONG>pos_form_cursor</STRONG>  restores  the  cursor  to  the position
60        required for the forms driver to continue processing requests.  This is
61        useful  after <STRONG>curses</STRONG> routines have been called to do screen-painting in
62        response to a form operation.
63
64
65 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
66        This routine returns one of the following:
67
68        <STRONG>E_OK</STRONG> The routine succeeded.
69
70        <STRONG>E_BAD_ARGUMENT</STRONG>
71             Routine detected an incorrect or out-of-range argument.
72
73        <STRONG>E_NOT_POSTED</STRONG>
74             The form has not been posted.
75
76        <STRONG>E_SYSTEM_ERROR</STRONG>
77             System error occurred (see <STRONG>errno(3)</STRONG>).
78
79
80 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
81        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
82
83
84 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
85        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
86        <STRONG>&lt;curses.h&gt;</STRONG>.
87
88
89 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
90        These  routines emulate the System V forms library.  They were not sup-
91        ported on Version 7 or BSD versions.
92
93
94 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
95        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
96        Raymond.
97
98
99
100                                                                <STRONG><A HREF="form_cursor.3x.html">form_cursor(3x)</A></STRONG>
101 </PRE>
102 <div class="nav">
103 <ul>
104 <li><a href="#h2-NAME">NAME</a></li>
105 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
106 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
107 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
108 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
109 <li><a href="#h2-NOTES">NOTES</a></li>
110 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
111 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
112 </ul>
113 </div>
114 </BODY>
115 </HTML>