X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_touch.3x.html;h=55eb33ea152584642ee4e99103684dbc84c587a7;hp=5b4d8212dd7d1b31ba9a08e9cb617e8d077dbd48;hb=d30f99439fcc8d4bb4c38e5c4afb4f6555fc6ad4;hpb=06078d3fa68db669ed37178c01873546b4b28745 diff --git a/doc/html/man/curs_touch.3x.html b/doc/html/man/curs_touch.3x.html index 5b4d8212..55eb33ea 100644 --- a/doc/html/man/curs_touch.3x.html +++ b/doc/html/man/curs_touch.3x.html @@ -1,6 +1,7 @@ - + curs_touch 3x - + @@ -52,12 +53,16 @@

SYNOPSIS

        #include <curses.h>
-       int touchwin(WINDOW *win);
-       int touchline(WINDOW *win, int start, int count);
-       int untouchwin(WINDOW *win);
-       int wtouchln(WINDOW *win, int y, int n, int changed);
-       bool is_linetouched(WINDOW *win, int line);
-       bool is_wintouched(WINDOW *win);
+
+       int touchline(WINDOW *win, int start, int count);
+
+       int touchwin(WINDOW *win);
+       int wtouchln(WINDOW *win, int y, int n, int changed);
+
+       int untouchwin(WINDOW *win);
+
+       bool is_linetouched(WINDOW *win, int line);
+       bool is_wintouched(WINDOW *win);

DESCRIPTION

@@ -91,25 +96,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.

PORTABILITY

-       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.

NOTES

-       Note that all routines except wtouchln may be macros.
+       All of these routines except wtouchln may be macros.

SEE ALSO