Ada95/html/man/curs_scanw.3x.html

   1 <HTML>
   2 <BODY>
   3 <PRE>
   4        <STRONG>scanw</STRONG>,  <STRONG>wscanw</STRONG>,  <STRONG>mvscanw</STRONG>, <STRONG>mvwscanw</STRONG>, <STRONG>vwscanw</STRONG> - convert for-
   5        matted input from a <STRONG>curses</STRONG> widow
   6
   7
   8 </PRE>
   9 <H2>SYNOPSIS</H2><PRE>
  10        <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
  11
  12        <STRONG>int</STRONG> <STRONG>scanw(char</STRONG> <STRONG>*fmt</STRONG> [<STRONG>,</STRONG> <STRONG>arg</STRONG>] <STRONG>...);</STRONG>
  13        <STRONG>int</STRONG> <STRONG>wscanw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt</STRONG> [<STRONG>,</STRONG> <STRONG>arg</STRONG>] <STRONG>...);</STRONG>
  14        <STRONG>int</STRONG> <STRONG>mvscanw(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt</STRONG> [<STRONG>,</STRONG> <STRONG>arg</STRONG>] <STRONG>...);</STRONG>
  15        <STRONG>int</STRONG> <STRONG>mvwscanw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG>
  16              <STRONG>char</STRONG> <STRONG>*fmt</STRONG> [<STRONG>,</STRONG> <STRONG>arg]</STRONG> <STRONG>...);</STRONG>
  17        <STRONG>int</STRONG> <STRONG>vwscanw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>va_list</STRONG> <STRONG>varglist);</STRONG>
  18
  19
  20 </PRE>
  21 <H2>DESCRIPTION</H2><PRE>
  22        The <STRONG>scanw</STRONG>, <STRONG>wscanw</STRONG> and <STRONG>mvscanw</STRONG> routines  are  analogous  to
  23        <STRONG>scanf</STRONG> [see <STRONG><A HREF="scanf.3s.html">scanf(3S)</A></STRONG>].  The effect of these routines is as
  24        though <STRONG>wgetstr</STRONG> were called on the window, and the  result-
  25        ing line used as input for <STRONG><A HREF="sscanf.3.html">sscanf(3)</A></STRONG>.  Fields which do not
  26        map to a variable in the <EM>fmt</EM> field are lost.
  27
  28        The <STRONG>vwscanw</STRONG> routine is similar to <STRONG>vwprintw</STRONG> in that it per-
  29        forms  a <STRONG>wscanw</STRONG> using a variable argument list.  The third
  30        argument is a <EM>va</EM>_<EM>list</EM>, a pointer to a list  of  arguments,
  31        as defined in <STRONG><varargs.h></STRONG>.
  32
  33
  34 </PRE>
  35 <H2>RETURN VALUE</H2><PRE>
  36        <STRONG>vwscanw</STRONG> returns <STRONG>ERR</STRONG> on failure and an integer equal to the
  37        number of fields scanned on success.
  38
  39        Applications may use the  return  value  from  the  <STRONG>scanw</STRONG>,
  40        <STRONG>wscanw</STRONG>,  <STRONG>mvscanw</STRONG>  and  <STRONG>mvwscanw</STRONG>  routines to determine the
  41        number of fields which were mapped in the call.
  42
  43
  44 </PRE>
  45 <H2>PORTABILITY</H2><PRE>
  46        The XSI Curses standard, Issue  4  describes  these  func-
  47        tions.   The  function  <STRONG>vwscanw</STRONG> is marked TO BE WITHDRAWN,
  48        and is to be replaced by a  function  <STRONG>vw_scanw</STRONG>  using  the
  49        <STRONG><stdarg.h></STRONG> interface.
  50
  51
  52 </PRE>
  53 <H2>SEE ALSO</H2><PRE>
  54        <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>, <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3X)</A></STRONG>, <STRONG><A HREF="curs_printw.3x.html">curs_printw(3X)</A></STRONG>, <STRONG><A HREF="scanf.3s.html">scanf(3S)</A></STRONG>
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66 </PRE>
  67 </BODY>
  68 </HTML>