ncurses 5.7 - patch 20100814
[ncurses.git] / man / curs_inch.3x
index 486d6d614480eddc8ce21e348091c5d1d6184e7d..5faa7633030441b8f79435d703ceb7eee517163b 100644 (file)
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_inch.3x,v 1.14 2010/07/31 16:11:27 tom Exp $
+.\" $Id: curs_inch.3x,v 1.16 2010/08/14 23:35:36 tom Exp $
 .TH curs_inch 3X ""
 .SH NAME
-\fBinch\fR, \fBwinch\fR, \fBmvinch\fR, \fBmvwinch\fR
-\- get a character and attributes from a \fBcurses\fR window
+\fBinch\fR,
+\fBwinch\fR,
+\fBmvinch\fR,
+\fBmvwinch\fR \- get a character and attributes from a \fBcurses\fR window
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 .sp
@@ -59,6 +61,10 @@ l l .
 \fBA_ATTRIBUTES\fR     Bit-mask to extract attributes
 \fBA_COLOR\fR  Bit-mask to extract color-pair field information
 .TE
+.SH RETURN VALUE
+Functions with a "mv" prefix first perform a cursor movement using
+\fBwmove\fP, and return an error if the position is outside the window,
+or if the window pointer is null.
 .SH NOTES
 Note that all of these routines may be macros.
 .SH PORTABILITY