X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_touch.3x.html;h=72326e6f2604d83cc8c724b802ddfdf51e074dd1;hp=5b4d8212dd7d1b31ba9a08e9cb617e8d077dbd48;hb=8d3ea9021573747ecd129228ba7782a03243f62c;hpb=06078d3fa68db669ed37178c01873546b4b28745
diff --git a/doc/html/man/curs_touch.3x.html b/doc/html/man/curs_touch.3x.html
index 5b4d8212..72326e6f 100644
--- a/doc/html/man/curs_touch.3x.html
+++ b/doc/html/man/curs_touch.3x.html
@@ -26,7 +26,7 @@
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_touch.3x,v 1.17 2017/11/18 23:40:19 tom Exp @
+ * @Id: curs_touch.3x,v 1.20 2017/11/25 16:19:42 tom Exp @
-->
@@ -91,25 +91,35 @@
is_linetouched
returns an error if the window pointer is null, or if the line
- number is outside the window. Note that ERR is distinct from
- TRUE and FALSE, which are the normal return values of this
- function.
+ number is outside the window.
+
+ The constant ERR is distinct from TRUE and FALSE, which are the
+ normal return values of this function. Because the function
+ returns a bool, returning ERR (which is neither TRUE nor FALSE)
+ may not be supported by the compiler.
+
+ To provide error-checking and also match the X/Open function
+ prototype, the ERR is provided by a macro named is_linetouched.
+ The actual function returns FALSE when it detects an error.
wtouchln
- returns an error if the window pointer is null, or if the line
+ returns an error if the window pointer is null, or if the line
number is outside the window.
- The XSI Curses standard, Issue 4 describes these functions.
+ These functions were introduced by SVr4. The Solaris curses header
+ file, for instance, defines both an actual function and macro for each.
+ The macros give the same result as the actual functions. SVr4 curses
+ does not check the window parameter win to ensure that it is not NULL;
+ otherwise this implementation behaves the same as SVr4.
- Some historic curses implementations had, as an undocumented feature,
- the ability to do the equivalent of clearok(..., 1) by saying touch-
- win(stdscr) or clear(stdscr). This will not work under ncurses.
+ The XSI Curses standard, Issue 4 describes these functions, but defines
+ no error conditions.
- Note that all routines except wtouchln may be macros.
+ All of these routines except wtouchln may be macros.