Module Name: src
Committed By: blymn
Date: Sun Aug 7 10:55:59 UTC 2011
Modified Files:
src/lib/libcurses: curses_inch.3
Log Message:
Document the return values for innstr and friends.
To generate a diff of this commit:
cvs rdiff -u -r1.10 -r1.11 src/lib/libcurses/curses_inch.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/libcurses/curses_inch.3
diff -u src/lib/libcurses/curses_inch.3:1.10 src/lib/libcurses/curses_inch.3:1.11
--- src/lib/libcurses/curses_inch.3:1.10 Wed Apr 21 06:24:32 2004
+++ src/lib/libcurses/curses_inch.3 Sun Aug 7 10:55:59 2011
@@ -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 ([email protected], [email protected])
@@ -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.