X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_inchstr.3x;h=2dc7673c3768163ad001958925fbf7634fb378d1;hp=18c21dc3190d35e144da0346d24174ac18bcd300;hb=b0916ab669030bac5c8590c0d66e36e1b9b34e9b;hpb=027ae42953e3186daed8f3882da73de48291b606 diff --git a/man/curs_inchstr.3x b/man/curs_inchstr.3x index 18c21dc3..2dc7673c 100644 --- a/man/curs_inchstr.3x +++ b/man/curs_inchstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 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.12 2006/12/02 17:00:58 tom Exp $ +.\" $Id: curs_inchstr.3x,v 1.15 2010/12/04 18:36:44 tom Exp $ .TH curs_inchstr 3X "" .na .hy 0 @@ -38,7 +38,7 @@ \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 @@ -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 @@ -93,9 +97,3 @@ that the successful return of the functions is \fBOK\fR. Comparable functions in the wide-character (ncursesw) library are described in \fBcurs_in_wchstr\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: