ncurses 5.6 - patch 20080621
[ncurses.git] / doc / html / man / menu_cursor.3x.html
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: menu_cursor.3x,v 1.6 2006/11/04 17:13:57 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>menu_cursor 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>menu_cursor 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44 <STRONG><A HREF="menu_cursor.3x.html">menu_cursor(3x)</A></STRONG>                                         <STRONG><A HREF="menu_cursor.3x.html">menu_cursor(3x)</A></STRONG>
45
46
47
48
49 </PRE>
50 <H2>NAME</H2><PRE>
51        <STRONG>menu_cursor</STRONG> - position a menu's cursor
52
53
54 </PRE>
55 <H2>SYNOPSIS</H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
57        int pos_menu_cursor(const MENU *menu);
58
59
60 </PRE>
61 <H2>DESCRIPTION</H2><PRE>
62        The  function  <STRONG>pos_menu_cursor</STRONG>  restores the cursor to the
63        current position associated with the menu's selected item.
64        This  is  useful after <STRONG>curses</STRONG> routines have been called to
65        do screen-painting in response to a menu select.
66
67
68 </PRE>
69 <H2>RETURN VALUE</H2><PRE>
70        This routine returns one of the following:
71
72        <STRONG>E_OK</STRONG> The routine succeeded.
73
74        <STRONG>E_SYSTEM_ERROR</STRONG>
75             System error occurred (see <STRONG>errno</STRONG>).
76
77        <STRONG>E_BAD_ARGUMENT</STRONG>
78             Routine detected an incorrect or  out-of-range  argu-
79             ment.
80
81        <STRONG>E_NOT_POSTED</STRONG>
82             The menu has not been posted.
83
84
85 </PRE>
86 <H2>SEE ALSO</H2><PRE>
87        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
88
89
90 </PRE>
91 <H2>NOTES</H2><PRE>
92        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
93        file <STRONG>&lt;curses.h&gt;</STRONG>.
94
95
96 </PRE>
97 <H2>PORTABILITY</H2><PRE>
98        These routines emulate the System V  menu  library.   They
99        were not supported on Version 7 or BSD versions.
100
101
102 </PRE>
103 <H2>AUTHORS</H2><PRE>
104        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
105        curses by Eric S. Raymond.
106
107
108
109                                                         <STRONG><A HREF="menu_cursor.3x.html">menu_cursor(3x)</A></STRONG>
110 </PRE>
111 <HR>
112 <ADDRESS>
113 Man(1) output converted with
114 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
115 </ADDRESS>
116 </BODY>
117 </HTML>