X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_scanw.3x.html;h=8bbd242fa1f061b80a84412bd22dd6e8a21b7e3e;hp=a7576669aded40016af653be64dc6e55d83fb88a;hb=89730563d0a660d4ddd83d28660dc23c6d3f0bed;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280 diff --git a/doc/html/man/curs_scanw.3x.html b/doc/html/man/curs_scanw.3x.html index a7576669..8bbd242f 100644 --- a/doc/html/man/curs_scanw.3x.html +++ b/doc/html/man/curs_scanw.3x.html @@ -27,7 +27,7 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_scanw.3x,v 1.26 2020/02/02 23:34:34 tom Exp @ + * @Id: curs_scanw.3x,v 1.27 2020/03/15 00:14:30 tom Exp @ --> @@ -89,41 +89,70 @@ the window pointer is null. +

HISTORY

+       While  scanw  was implemented in 4BSD, none of the BSD releases used it
+       until 4.4BSD (in a game).  That early version of curses was before  the
+       ANSI  C  standard.   It did not use <varargs.h>, though that was avail-
+       able.  In 1991 (a couple of years after SVr4 was  generally  available,
+       and  after  the C standard was published), other developers updated the
+       library, using <stdarg.h> internally in 4.4BSD curses.  Even with  this
+       improvement,  BSD  curses  did  not  use  function  prototypes (or even
+       declare functions) in the <curses.h> header until 1992.
+
+       SVr2 documented scanw, wscanw tersely as  "scanf  through  stdscr"  and
+       tersely as "scanf through win", respectively.
+
+       SVr3 added mvscanw, and mvwscanw, with a three-line summary saying that
+       they were analogous to scanf(3), explaining that the string which would
+       be  output  from  scanf(3) would instead be output using waddstr on the
+       given window.  SVr3 also added vwscanw, saying that the third parameter
+       is  a  va_list, defined in <varargs.h>, and referring the reader to the
+       manual  pages  for  varargs  and  vprintf  for  detailed  descriptions.
+       (Because the SVr3 documentation does not mention vscanf, that reference
+       to vprintf may not be an error).
+
+       SVr4  added  no  new  variations  of  scanw,  but  provided  for  using
+       <varargs.h> or <stdarg.h> to define the va_list type.
+
+       X/Open  Curses  added  vw_scanw  to  replace  vwscanw, stating that its
+       va_list definition requires <stdarg.h>.
+
+
 

PORTABILITY

        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
+       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
+       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
+       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
+       Both XSI and The Single Unix Specification, Version 2 state that  these
        functions return ERR or OK.
 
-       o   Since the underlying  scanf(3)  can  return  the  number  of  items
+       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
+           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
+       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,
+       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
+           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.
 
 
@@ -141,6 +170,7 @@
 
  • SYNOPSIS
  • DESCRIPTION
  • RETURN VALUE
  • +
  • HISTORY
  • PORTABILITY
  • SEE ALSO