X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_scanw.3x.html;h=a7576669aded40016af653be64dc6e55d83fb88a;hp=b6331f0935c2ce0ad0abd1cc20bdb5297cc28039;hb=47d2fb4537d9ad5bb14f4810561a327930ca4280;hpb=bca50d0d8592defee6c584fdedd25f4b1a31345b diff --git a/doc/html/man/curs_scanw.3x.html b/doc/html/man/curs_scanw.3x.html index b6331f09..a7576669 100644 --- a/doc/html/man/curs_scanw.3x.html +++ b/doc/html/man/curs_scanw.3x.html @@ -1,6 +1,7 @@ @@ -34,7 +35,7 @@ curs_scanw 3x - + @@ -53,12 +54,14 @@

SYNOPSIS

        #include <curses.h>
 
-       int scanw(char *fmt, ...);
-       int wscanw(WINDOW *win, char *fmt, ...);
-       int mvscanw(int y, int x, char *fmt, ...);
-       int mvwscanw(WINDOW *win, int y, int x, char *fmt, ...);
-       int vw_scanw(WINDOW *win, char *fmt, va_list varglist);
-       int vwscanw(WINDOW *win, char *fmt, va_list varglist);
+       int scanw(const char *fmt, ...);
+       int wscanw(WINDOW *win, const char *fmt, ...);
+       int mvscanw(int y, int x, const char *fmt, ...);
+       int mvwscanw(WINDOW *win, int y, int x, const char *fmt, ...);
+       int vw_scanw(WINDOW *win, const char *fmt, va_list varglist);
+
+       /* obsolete */
+       int vwscanw(WINDOW *win, const char *fmt, va_list varglist);
 
 
 

DESCRIPTION

@@ -87,27 +90,46 @@
 
 
 

PORTABILITY

-       The  XSI Curses standard, Issue 4 describes these functions.  The func-
-       tion vwscanw is marked TO BE WITHDRAWN, and is  to  be  replaced  by  a
-       function  vw_scanw  using  the  <stdarg.h>  interface.  The Single Unix
-       Specification, Version 2 states that vw_scanw  is preferred to  vwscanw
-       since  the  latter requires including <varargs.h>, which cannot be used
-       in the same file as <stdarg.h>.  This  implementation  uses  <stdarg.h>
-       for both, because that header is included in <curses.h>.
+       In this implementation, vw_scanw and vwscanw are equivalent, to support
+       legacy applications.  However, the latter (vwscanw) is obsolete:
+
+       o   The XSI Curses standard, Issue 4 described these functions,  noting
+           that  the  function vwscanw is marked TO BE WITHDRAWN, and is to be
+           replaced by a function vw_scanw using the <stdarg.h> interface.
+
+       o   The Single Unix Specification, Version 2 states that  vw_scanw   is
+           preferred   to   vwscanw   since   the  latter  requires  including
+           <varargs.h>, which cannot be used in the same file  as  <stdarg.h>.
+           This  implementation  uses <stdarg.h> for both, because that header
+           is included in <curses.h>.
+
+       o   X/Open Curses, Issue 5 (December 2007) marked vwscanw  (along  with
+           vwprintw and the termcap interface) as withdrawn.
 
        Both  XSI and The Single Unix Specification, Version 2 state that these
-       functions return ERR or OK.  Since the underlying scanf(3)  can  return
-       the  number  of  items scanned, and the SVr4 code was documented to use
-       this feature, this is probably an editing error which was introduced in
-       XSI,  rather  than  being  done  intentionally.   Portable applications
-       should only test if the return value is ERR, since the OK value  (zero)
-       is  likely  to  be  misleading.  One possible way to get useful results
-       would be to use a "%n" conversion at the end of the  format  string  to
-       ensure that something was processed.
+       functions return ERR or OK.
+
+       o   Since the underlying  scanf(3)  can  return  the  number  of  items
+           scanned, and the SVr4 code was documented to use this feature, this
+           is probably an editing error which was introduced  in  XSI,  rather
+           than being done intentionally.
+
+       o   This  implementation  returns the number of items scanned, for com-
+           patibility with SVr4  curses.   As  of  2018,  NetBSD  curses  also
+           returns  the  number  of  items  scanned.   Both ncurses and NetBSD
+           curses call vsscanf to scan the string, which returns EOF on error.
+
+       o   Portable applications should only test if the return value is  ERR,
+           since the OK value (zero) is likely to be misleading.
+
+           One  possible way to get useful results would be to use a "%n" con-
+           version at the end of the format string to  ensure  that  something
+           was processed.
 
 
 

SEE ALSO

-       curses(3x), curs_getstr(3x), curs_printw(3x), scanf(3)
+       curses(3x), curs_getstr(3x), curs_printw(3x), curs_termcap(3x),
+       scanf(3).