[src/trunk]: src/lib/libcurses Document the return values for innstr and frie...

[blymn <blymn%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/7dc679847f16
branches:  trunk
changeset: 768053:7dc679847f16
user:      blymn <blymn%NetBSD.org@localhost>
date:      Sun Aug 07 10:55:59 2011 +0000

description:
Document the return values for innstr and friends.

diffstat:

 lib/libcurses/curses_inch.3 |  9 ++++++++-
 1 files changed, 8 insertions(+), 1 deletions(-)

diffs (23 lines):

diff -r 165369901832 -r 7dc679847f16 lib/libcurses/curses_inch.3
--- a/lib/libcurses/curses_inch.3       Sun Aug 07 10:54:53 2011 +0000
+++ b/lib/libcurses/curses_inch.3       Sun Aug 07 10:55:59 2011 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: curses_inch.3,v 1.10 2004/04/21 06:24:32 jdc Exp $
+.\"    $NetBSD: curses_inch.3,v 1.11 2011/08/07 10:55:59 blymn Exp $
 .\"
 .\" Copyright (c) 2002
 .\"    Brett Lymn (blymn%NetBSD.org@localhost, brett_lymn%yahoo.com.au@localhost)
@@ -219,6 +219,13 @@
 .Fn winstr
 is not recommended.
 .Sh RETURN VALUES
+If the calls
+.Fn innstr ,
+.Fn mvinnstr ,
+.Fn mvwinnstr
+and
+.Fn winnstr 
+succeed then they will return the number of characters actually read.
 Functions returning pointers will return
 .Dv NULL
 if an error is detected.