doc/html/man/curs_scanw.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
   4   * Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: curs_scanw.3x,v 1.28 2020/10/24 09:29:26 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>curs_scanw 3X</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">curs_scanw 3X</H1>
  43 <PRE>
  44 <B><A HREF="curs_scanw.3X.html">curs_scanw(3X)</A></B>                                                  <B><A HREF="curs_scanw.3X.html">curs_scanw(3X)</A></B>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <B>scanw</B>, <B>wscanw</B>, <B>mvscanw</B>, <B>mvwscanw</B>, <B>vwscanw</B>, <B>vw_scanw</B> - convert formatted
  51        input from a <B>curses</B> window
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <B>#include</B> <B>&lt;curses.h&gt;</B>
  56
  57        <B>int</B> <B>scanw(const</B> <B>char</B> <B>*</B><I>fmt</I><B>,</B> <B>...);</B>
  58        <B>int</B> <B>wscanw(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>fmt</I><B>,</B> <B>...);</B>
  59        <B>int</B> <B>mvscanw(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>fmt</I><B>,</B> <B>...);</B>
  60        <B>int</B> <B>mvwscanw(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>fmt</I><B>,</B> <B>...);</B>
  61
  62        <B>int</B> <B>vw_scanw(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>fmt</I><B>,</B> <B>va_list</B> <I>varglist</I><B>);</B>
  63
  64        /* obsolete */
  65        <B>int</B> <B>vwscanw(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>fmt</I><B>,</B> <B>va_list</B> <I>varglist</I><B>);</B>
  66
  67
  68 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  69        The <B>scanw</B>, <B>wscanw</B> and <B>mvscanw</B> routines  are  analogous  to  <B>scanf</B>  [see
  70        <B>scanf(3)</B>].   The  effect  of  these  routines is as though <B>wgetstr</B> were
  71        called on the  window,  and  the  resulting  line  used  as  input  for
  72        <B>sscanf(3)</B>.   Fields which do not map to a variable in the <I>fmt</I> field are
  73        lost.
  74
  75        The <B>vwscanw</B> and <B>vw_scanw</B> routines are  analogous  to  <B>vscanf(3)</B>.   They
  76        perform a <B>wscanw</B> using a variable argument list.  The third argument is
  77        a <I>va</I><B>_</B><I>list</I>, a pointer to a list of arguments, as defined in <B>&lt;stdarg.h&gt;</B>.
  78
  79
  80 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  81        <B>vwscanw</B> returns <B>ERR</B> on failure and an integer equal to  the  number  of
  82        fields scanned on success.
  83
  84        Applications  may  use the return value from the <B>scanw</B>, <B>wscanw</B>, <B>mvscanw</B>
  85        and <B>mvwscanw</B> routines to determine the  number  of  fields  which  were
  86        mapped in the call.
  87
  88        Functions  with  a  "mv"  prefix  first perform a cursor movement using
  89        <B>wmove</B>, and return an error if the position is outside the window, or if
  90        the window pointer is null.
  91
  92
  93 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
  94        While  <B>scanw</B>  was implemented in 4BSD, none of the BSD releases used it
  95        until 4.4BSD (in a game).  That early version of curses was before  the
  96        ANSI  C  standard.   It  did  not  use  &lt;varargs.h&gt;,  though  that  was
  97        available.  In 1991  (a  couple  of  years  after  SVr4  was  generally
  98        available,  and  after  the C standard was published), other developers
  99        updated the library, using  &lt;stdarg.h&gt;  internally  in  4.4BSD  curses.
 100        Even  with this improvement, BSD curses did not use function prototypes
 101        (or even declare functions) in the &lt;curses.h&gt; header until 1992.
 102
 103        SVr2 documented <B>scanw</B>, <B>wscanw</B> tersely as  "scanf  through  <I>stdscr</I>"  and
 104        tersely as "scanf through <I>win</I>", respectively.
 105
 106        SVr3 added <B>mvscanw</B>, and <B>mvwscanw</B>, with a three-line summary saying that
 107        they were analogous to <B>scanf(3)</B>, explaining that the string which would
 108        be  output  from  <B>scanf(3)</B> would instead be output using <B>waddstr</B> on the
 109        given window.  SVr3 also added <B>vwscanw</B>, saying that the third parameter
 110        is  a  <B>va_list</B>, defined in &lt;varargs.h&gt;, and referring the reader to the
 111        manual  pages  for  <I>varargs</I>  and  <I>vprintf</I>  for  detailed  descriptions.
 112        (Because the SVr3 documentation does not mention <I>vscanf</I>, that reference
 113        to <I>vprintf</I> may not be an error).
 114
 115        SVr4  added  no  new  variations  of  <B>scanw</B>,  but  provided  for  using
 116        &lt;varargs.h&gt; or &lt;stdarg.h&gt; to define the <B>va_list</B> type.
 117
 118        X/Open  Curses  added  <B>vw_scanw</B>  to  replace  <B>vwscanw</B>, stating that its
 119        <B>va_list</B> definition requires &lt;stdarg.h&gt;.
 120
 121
 122 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 123        In this implementation, <B>vw_scanw</B> and <B>vwscanw</B> are equivalent, to support
 124        legacy applications.  However, the latter (<B>vwscanw</B>) is obsolete:
 125
 126        <B>o</B>   The  XSI Curses standard, Issue 4 described these functions, noting
 127            that the function <B>vwscanw</B> is marked TO BE WITHDRAWN, and is  to  be
 128            replaced by a function <B>vw_scanw</B> using the <B>&lt;stdarg.h&gt;</B> interface.
 129
 130        <B>o</B>   The  Single  Unix Specification, Version 2 states that <B>vw_scanw</B>  is
 131            preferred  to  <B>vwscanw</B>  since   the   latter   requires   including
 132            <B>&lt;varargs.h&gt;</B>,  which  cannot be used in the same file as <B>&lt;stdarg.h&gt;</B>.
 133            This implementation uses <B>&lt;stdarg.h&gt;</B> for both, because  that  header
 134            is included in <B>&lt;curses.h</B>&gt;.
 135
 136        <B>o</B>   X/Open  Curses,  Issue 5 (December 2007) marked <B>vwscanw</B> (along with
 137            <B>vwprintw</B> and the termcap interface) as withdrawn.
 138
 139        Both XSI and The Single Unix Specification, Version 2 state that  these
 140        functions return <B>ERR</B> or <B>OK</B>.
 141
 142        <B>o</B>   Since  the  underlying  <B>scanf(3)</B>  can  return  the  number of items
 143            scanned, and the SVr4 code was documented to use this feature, this
 144            is  probably  an  editing error which was introduced in XSI, rather
 145            than being done intentionally.
 146
 147        <B>o</B>   This implementation  returns  the  number  of  items  scanned,  for
 148            compatibility  with  SVr4  curses.   As of 2018, NetBSD curses also
 149            returns the number of  items  scanned.   Both  ncurses  and  NetBSD
 150            curses call <B>vsscanf</B> to scan the string, which returns <B>EOF</B> on error.
 151
 152        <B>o</B>   Portable  applications should only test if the return value is <B>ERR</B>,
 153            since the <B>OK</B> value (zero) is likely to be misleading.
 154
 155            One possible way to get useful results  would  be  to  use  a  "%n"
 156            conversion at the end of the format string to ensure that something
 157            was processed.
 158
 159
 160 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 161        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_getstr.3X.html">curs_getstr(3X)</A></B>, <B><A HREF="curs_printw.3X.html">curs_printw(3X)</A></B>, <B><A HREF="curs_termcap.3X.html">curs_termcap(3X)</A></B>,
 162        <B>scanf(3)</B>.
 163
 164
 165
 166                                                                 <B><A HREF="curs_scanw.3X.html">curs_scanw(3X)</A></B>
 167 </PRE>
 168 <div class="nav">
 169 <ul>
 170 <li><a href="#h2-NAME">NAME</a></li>
 171 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 172 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 173 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 174 <li><a href="#h2-HISTORY">HISTORY</a></li>
 175 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 176 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 177 </ul>
 178 </div>
 179 </BODY>
 180 </HTML>