Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / b2cef93693cf7cfd01098c9b69603c90f0f4b803 / . / doc / html / man / curs_scanw.3x.html
blob: ca8fe63161140fc9c1c13310a6d59db2d5a64b99 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1<!--
2 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]3 * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]4 * *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
12 * *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
15 * *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
27 * authorization. *
28 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]29 * @Id: curs_scanw.3x,v 1.17 2010/12/04 18:40:45 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]30-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]31<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]32<HTML>
33<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]34<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]36<TITLE>curs_scanw 3x</TITLE>
37<link rev=made href="mailto:bug-ncurses@gnu.org">
38<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39</HEAD>
40<BODY>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]41<H1 class="no-header">curs_scanw 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]42<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43<STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG> <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG>
44
45
46
47
48</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]49<H2><a name="h2-NAME">NAME</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]50 <STRONG>scanw</STRONG>, <STRONG>wscanw</STRONG>, <STRONG>mvscanw</STRONG>, <STRONG>mvwscanw</STRONG>, <STRONG>vwscanw</STRONG>, <STRONG>vw_scanw</STRONG> - con-
51 vert formatted input from a <STRONG>curses</STRONG> window
52
53
54</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]55<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]56 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58 <STRONG>int</STRONG> <STRONG>scanw(char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG>
59 <STRONG>int</STRONG> <STRONG>wscanw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG>
60 <STRONG>int</STRONG> <STRONG>mvscanw(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG>
61 <STRONG>int</STRONG> <STRONG>mvwscanw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG>
62 <STRONG>int</STRONG> <STRONG>vw_scanw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>va_list</STRONG> <STRONG>varglist);</STRONG>
63 <STRONG>int</STRONG> <STRONG>vwscanw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>va_list</STRONG> <STRONG>varglist);</STRONG>
64
65
66</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]67<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]68 The <STRONG>scanw</STRONG>, <STRONG>wscanw</STRONG> and <STRONG>mvscanw</STRONG> routines are analogous to
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]69 <STRONG>scanf</STRONG> [see <STRONG>scanf(3)</STRONG>]. The effect of these routines is as
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]70 though <STRONG>wgetstr</STRONG> were called on the window, and the result-
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]71 ing line used as input for <STRONG>sscanf(3)</STRONG>. Fields which do not
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]72 map to a variable in the <EM>fmt</EM> field are lost.
73
74 The <STRONG>vwscanw</STRONG> and <STRONG>vw_scanw</STRONG> routines are analogous to <STRONG>vscanf</STRONG>.
75 They perform a <STRONG>wscanw</STRONG> using a variable argument list. The
76 third argument is a <EM>va</EM><STRONG>_</STRONG><EM>list</EM>, a pointer to a list of argu-
77 ments, as defined in <STRONG>&lt;stdarg.h&gt;</STRONG>.
78
79
80</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]81<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]82 <STRONG>vwscanw</STRONG> returns <STRONG>ERR</STRONG> on failure and an integer equal to the
83 number of fields scanned on success.
84
85 Applications may use the return value from the <STRONG>scanw</STRONG>,
86 <STRONG>wscanw</STRONG>, <STRONG>mvscanw</STRONG> and <STRONG>mvwscanw</STRONG> routines to determine the
87 number of fields which were mapped in the call.
88
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]89 Functions with a "mv" prefix first perform a cursor move-
90 ment using <STRONG>wmove</STRONG>, and return an error if the position is
91 outside the window, or if the window pointer is null.
92
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]93
94</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]95<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]96 The XSI Curses standard, Issue 4 describes these func-
97 tions. The function <STRONG>vwscanw</STRONG> is marked TO BE WITHDRAWN,
98 and is to be replaced by a function <STRONG>vw_scanw</STRONG> using the
99 <STRONG>&lt;stdarg.h&gt;</STRONG> interface. The Single Unix Specification, Ver-
100 sion 2 states that <STRONG>vw_scanw</STRONG> is preferred to <STRONG>vwscanw</STRONG> since
101 the latter requires including <STRONG>&lt;varargs.h&gt;</STRONG>, which cannot be
102 used in the same file as <STRONG>&lt;stdarg.h&gt;</STRONG>. This implementation
103 uses <STRONG>&lt;stdarg.h&gt;</STRONG> for both, because that header is included
104 in <STRONG>&lt;curses.h</STRONG>&gt;.
105
106 Both XSI and The Single Unix Specification, Version 2
107 state that these functions return ERR or OK. Since the
108 underlying <STRONG>scanf</STRONG> can return the number of items scanned,
109 and the SVr4 code was documented to use this feature, this
110 is probably an editing error which was introduced in XSI,
111 rather than being done intentionally. Portable applica-
112 tions should only test if the return value is ERR, since
113 the OK value (zero) is likely to be misleading. One pos-
114 sible way to get useful results would be to use a "%n"
115 conversion at the end of the format string to ensure that
116 something was processed.
117
118
119</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]120<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
121 <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>scanf(3)</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]122
123
124
125 <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG>
126</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]127<div class="nav">
128<ul>
129<li><a href="#h2-NAME">NAME</a></li>
130<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
131<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
132<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
133<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
134<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
135</ul>
136</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]137</BODY>
138</HTML>