summaryrefslogtreecommitdiffstats
path: root/ncurses-5.2/doc/html/man/curs_scanw.3x.html
blob: 1fb1ba9ed2950dfcf56671159fb81b90253ed094 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
<HTML>
<BODY>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->

</PRE>
<H2>NAME</H2><PRE>
       <B>scanw</B>, <B>wscanw</B>, <B>mvscanw</B>, <B>mvwscanw</B>, <B>vwscanw</B>, <B>vw_scanw</B> - con-
       vert formatted input from a <B>curses</B> window


</PRE>
<H2>SYNOPSIS</H2><PRE>
       <B>#include</B> <B>&lt;curses.h&gt;</B>

       <B>int</B> <B>scanw(char</B> <B>*fmt</B> [<B>,</B> <B>arg</B>] <B>...);</B>
       <B>int</B> <B>wscanw(WINDOW</B> <B>*win,</B> <B>char</B> <B>*fmt</B> [<B>,</B> <B>arg</B>] <B>...);</B>
       <B>int</B> <B>mvscanw(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*fmt</B> [<B>,</B> <B>arg</B>] <B>...);</B>
       <B>int</B> <B>mvwscanw(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B>
             <B>char</B> <B>*fmt</B> [<B>,</B> <B>arg]</B> <B>...);</B>
       <B>int</B> <B>vw_scanw(WINDOW</B> <B>*win,</B> <B>char</B> <B>*fmt,</B> <B>va_list</B> <B>varglist);</B>
       <B>int</B> <B>vwscanw(WINDOW</B> <B>*win,</B> <B>char</B> <B>*fmt,</B> <B>va_list</B> <B>varglist);</B>


</PRE>
<H2>DESCRIPTION</H2><PRE>
       The <B>scanw</B>, <B>wscanw</B> and <B>mvscanw</B> routines  are  analogous  to
       <B>scanf</B> [see <B><A HREF="scanf.3S.html">scanf(3S)</A></B>].  The effect of these routines is as
       though <B>wgetstr</B> were called on the window, and the  result-
       ing line used as input for <B><A HREF="sscanf.3.html">sscanf(3)</A></B>.  Fields which do not
       map to a variable in the <I>fmt</I> field are lost.

       The <B>vwscanw</B> routine is similar to <B>vwprintw</B> in that it per-
       forms  a <B>wscanw</B> using a variable argument list.  The third
       argument is a <I>va</I>_<I>list</I>, a pointer to a list  of  arguments,
       as defined in <B>&lt;varargs.h&gt;</B>.


</PRE>
<H2>RETURN VALUE</H2><PRE>
       <B>vwscanw</B> returns <B>ERR</B> on failure and an integer equal to the
       number of fields scanned on success.

       Applications may use the  return  value  from  the  <B>scanw</B>,
       <B>wscanw</B>,  <B>mvscanw</B>  and  <B>mvwscanw</B>  routines to determine the
       number of fields which were mapped in the call.


</PRE>
<H2>PORTABILITY</H2><PRE>
       The XSI Curses standard, Issue  4  describes  these  func-
       tions.   The  function  <B>vwscanw</B> is marked TO BE WITHDRAWN,
       and is to be replaced by a  function  <B>vw_scanw</B>  using  the
       <B>&lt;stdarg.h&gt;</B> interface.


</PRE>
<H2>SEE ALSO</H2><PRE>
       <B><A HREF="ncurses.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="scanf.3S.html">scanf(3S)</A></B>











</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>