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