X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_touch.3x.html;h=acbbb6a03e5dcc0233812b33ed028bc28671442e;hp=d63e4de8d24ed2ee2ba3104fbba51ed252acd3e5;hb=c0f109a299a82a33c16bd7af942a12ce9aefaaf0;hpb=ed646e3f683083e787c6ba773364401dc9fa9d40
diff --git a/doc/html/man/curs_touch.3x.html b/doc/html/man/curs_touch.3x.html
index d63e4de8..acbbb6a0 100644
--- a/doc/html/man/curs_touch.3x.html
+++ b/doc/html/man/curs_touch.3x.html
@@ -1,6 +1,7 @@
-
+
curs_touch 3x
-
+
@@ -89,27 +90,37 @@
X/Open does not define any error conditions. In this implementation
- is_linetouched
- returns an error if the window pointer is null, or if the
- line number is outside the window. Note that ERR is dis-
- tinct from TRUE and FALSE, which are the normal return val-
- ues of this function.
+ is_linetouched
+ returns an error if the window pointer is null, or if the line
+ number is outside the window.
- wtouchln
- returns an error if the window pointer is null, or if the
- line 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
+ 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.