ncurses 5.7 - patch 20110115
[ncurses.git] / man / curs_inchstr.3x
index cb91aa442eeba2fcb9f859e8e476af12ed39d5e1..2dc7673c3768163ad001958925fbf7634fb378d1 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998-2000,2005 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
@@ -26,7 +26,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_inchstr.3x,v 1.10 2005/05/15 16:54:53 tom Exp $
+.\" $Id: curs_inchstr.3x,v 1.15 2010/12/04 18:36:44 tom Exp $
 .TH curs_inchstr 3X ""
 .na
 .hy 0
 \fBmvinchstr\fR,
 \fBmvinchnstr\fR,
 \fBmvwinchstr\fR,
-\fBmvwinchnstr\fR - get a string of characters (and attributes) from a \fBcurses\fR window
+\fBmvwinchnstr\fR \- get a string of characters (and attributes) from a \fBcurses\fR window
 .ad
 .hy
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
-
+.sp
 \fBint inchstr(chtype *chstr);\fR
 .br
 \fBint inchnstr(chtype *chstr, int n);\fR
@@ -78,9 +78,13 @@ No error conditions are defined.
 If the \fIchstr\fP parameter is null,
 no data is returned,
 and the return value is zero.
+.PP
+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 routines except \fBwinchnstr\fR may be macros.  SVr4 does not
-document whether the result string is 0-terminated; it does not document
+document whether the result string is zero-terminated; it does not document
 whether a length limit argument includes any trailing 0; and it does not
 document the meaning of the return value.
 .SH PORTABILITY
@@ -89,9 +93,7 @@ more specific than the SVr4 documentation on the trailing 0.  It does specify
 that the successful return of the functions is \fBOK\fR.
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBcurs_inch\fR(3X).
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End:
+.PP
+Comparable functions in the wide-character (ncursesw) library are
+described in
+\fBcurs_in_wchstr\fR(3X).