ncurses 4.1
[ncurses.git] / man / menu_cursor.3x
1 '\" t
2 .TH menu_cursor 3X ""
3 .SH NAME
4 \fBmenu_cursor\fR - position a menu's cursor
5 .SH SYNOPSIS
6 \fB#include <menu.h>\fR
7 .br
8 int pos_menu_cursor(const MENU *menu);
9 .br
10 .SH DESCRIPTION
11 The function \fBpos_menu_cursor\fR restores the cursor to the current position
12 associated with the menu's selected item.  This is useful after \fBcurses\fR
13 routines have been called to do screen-painting in response to a menu select.
14 .SH RETURN VALUE
15 This routine returns one of the following:
16 .TP 5
17 \fBE_OK\fR
18 The routine succeeded.
19 .TP 5
20 \fBE_SYSTEM_ERROR\fR
21 System error occurred (see \fBerrno\fR).
22 .TP 5
23 \fBE_BAD_ARGUMENT\fR
24 Routine detected an incorrect or out-of-range argument.
25 .TP 5
26 \fBE_NOT_POSTED\fR
27 The menu has not been posted.
28 .SH SEE ALSO
29 \fBcurses\fR(3X), \fBmenu\fR(3X).
30 .SH NOTES
31 The header file \fB<menu.h>\fR automatically includes the header file
32 \fB<curses.h>\fR.
33 .SH PORTABILITY
34 These routines emulate the System V menu library.  They were not supported on
35 Version 7 or BSD versions.
36 .SH AUTHORS
37 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
38 S. Raymond.
39 .\"#
40 .\"# The following sets edit modes for GNU EMACS
41 .\"# Local Variables:
42 .\"# mode:nroff
43 .\"# fill-column:79
44 .\"# End: