2002-10-13 11:35:53 +08:00
|
|
|
<!--
|
|
|
|
|
****************************************************************************
|
2010-08-01 08:45:28 +08:00
|
|
|
* Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
|
2002-10-13 11:35:53 +08:00
|
|
|
* *
|
|
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a *
|
|
|
|
|
* copy of this software and associated documentation files (the *
|
|
|
|
|
* "Software"), to deal in the Software without restriction, including *
|
|
|
|
|
* without limitation the rights to use, copy, modify, merge, publish, *
|
|
|
|
|
* distribute, distribute with modifications, sublicense, and/or sell *
|
|
|
|
|
* copies of the Software, and to permit persons to whom the Software is *
|
|
|
|
|
* furnished to do so, subject to the following conditions: *
|
|
|
|
|
* *
|
|
|
|
|
* The above copyright notice and this permission notice shall be included *
|
|
|
|
|
* in all copies or substantial portions of the Software. *
|
|
|
|
|
* *
|
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|
|
|
|
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|
|
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|
|
|
|
* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|
|
|
|
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|
|
|
|
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|
|
|
|
* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
|
|
|
* *
|
|
|
|
|
* Except as contained in this notice, the name(s) of the above copyright *
|
|
|
|
|
* holders shall not be used in advertising or otherwise to promote the *
|
|
|
|
|
* sale, use or other dealings in this Software without prior written *
|
|
|
|
|
* authorization. *
|
|
|
|
|
****************************************************************************
|
2011-01-09 09:17:12 +08:00
|
|
|
* @Id: curs_scanw.3x,v 1.17 2010/12/04 18:40:45 tom Exp @
|
2002-10-13 11:35:53 +08:00
|
|
|
-->
|
2015-02-15 09:42:27 +08:00
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
|
2000-07-09 10:46:08 +08:00
|
|
|
<HTML>
|
2002-10-13 11:35:53 +08:00
|
|
|
<HEAD>
|
2015-02-15 09:42:27 +08:00
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
|
|
|
|
|
<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
|
2002-10-13 11:35:53 +08:00
|
|
|
<TITLE>curs_scanw 3x</TITLE>
|
|
|
|
|
<link rev=made href="mailto:bug-ncurses@gnu.org">
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
|
|
|
</HEAD>
|
2000-07-09 10:46:08 +08:00
|
|
|
<BODY>
|
2015-05-17 05:01:22 +08:00
|
|
|
<H1 class="no-header">curs_scanw 3x</H1>
|
2000-07-09 10:46:08 +08:00
|
|
|
<PRE>
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG> <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG>
|
2004-02-09 10:15:26 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>scanw</STRONG>, <STRONG>wscanw</STRONG>, <STRONG>mvscanw</STRONG>, <STRONG>mvwscanw</STRONG>, <STRONG>vwscanw</STRONG>, <STRONG>vw_scanw</STRONG> - con-
|
|
|
|
|
vert formatted input from a <STRONG>curses</STRONG> window
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>int</STRONG> <STRONG>scanw(char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG>
|
|
|
|
|
<STRONG>int</STRONG> <STRONG>wscanw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>...);</STRONG>
|
|
|
|
|
<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>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>
|
|
|
|
|
<STRONG>int</STRONG> <STRONG>vw_scanw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>va_list</STRONG> <STRONG>varglist);</STRONG>
|
|
|
|
|
<STRONG>int</STRONG> <STRONG>vwscanw(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*fmt,</STRONG> <STRONG>va_list</STRONG> <STRONG>varglist);</STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
The <STRONG>scanw</STRONG>, <STRONG>wscanw</STRONG> and <STRONG>mvscanw</STRONG> routines are analogous to
|
2013-12-22 07:12:46 +08:00
|
|
|
<STRONG>scanf</STRONG> [see <STRONG>scanf(3)</STRONG>]. The effect of these routines is as
|
2002-10-13 11:35:53 +08:00
|
|
|
though <STRONG>wgetstr</STRONG> were called on the window, and the result-
|
2013-12-22 07:12:46 +08:00
|
|
|
ing line used as input for <STRONG>sscanf(3)</STRONG>. Fields which do not
|
2002-10-13 11:35:53 +08:00
|
|
|
map to a variable in the <EM>fmt</EM> field are lost.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
The <STRONG>vwscanw</STRONG> and <STRONG>vw_scanw</STRONG> routines are analogous to <STRONG>vscanf</STRONG>.
|
|
|
|
|
They perform a <STRONG>wscanw</STRONG> using a variable argument list. The
|
|
|
|
|
third argument is a <EM>va</EM><STRONG>_</STRONG><EM>list</EM>, a pointer to a list of argu-
|
|
|
|
|
ments, as defined in <STRONG><stdarg.h></STRONG>.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>vwscanw</STRONG> returns <STRONG>ERR</STRONG> on failure and an integer equal to the
|
2000-07-09 10:46:08 +08:00
|
|
|
number of fields scanned on success.
|
|
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
Applications may use the return value from the <STRONG>scanw</STRONG>,
|
|
|
|
|
<STRONG>wscanw</STRONG>, <STRONG>mvscanw</STRONG> and <STRONG>mvwscanw</STRONG> routines to determine the
|
2000-07-09 10:46:08 +08:00
|
|
|
number of fields which were mapped in the call.
|
|
|
|
|
|
2010-09-19 08:45:46 +08:00
|
|
|
Functions with a "mv" prefix first perform a cursor move-
|
|
|
|
|
ment using <STRONG>wmove</STRONG>, and return an error if the position is
|
|
|
|
|
outside the window, or if the window pointer is null.
|
|
|
|
|
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
2000-07-09 10:46:08 +08:00
|
|
|
The XSI Curses standard, Issue 4 describes these func-
|
2002-10-13 11:35:53 +08:00
|
|
|
tions. The function <STRONG>vwscanw</STRONG> is marked TO BE WITHDRAWN,
|
|
|
|
|
and is to be replaced by a function <STRONG>vw_scanw</STRONG> using the
|
|
|
|
|
<STRONG><stdarg.h></STRONG> interface. The Single Unix Specification, Ver-
|
|
|
|
|
sion 2 states that <STRONG>vw_scanw</STRONG> is preferred to <STRONG>vwscanw</STRONG> since
|
|
|
|
|
the latter requires including <STRONG><varargs.h></STRONG>, which cannot be
|
|
|
|
|
used in the same file as <STRONG><stdarg.h></STRONG>. This implementation
|
|
|
|
|
uses <STRONG><stdarg.h></STRONG> for both, because that header is included
|
|
|
|
|
in <STRONG><curses.h</STRONG>>.
|
|
|
|
|
|
|
|
|
|
Both XSI and The Single Unix Specification, Version 2
|
|
|
|
|
state that these functions return ERR or OK. Since the
|
|
|
|
|
underlying <STRONG>scanf</STRONG> 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 than being done intentionally. Portable applica-
|
|
|
|
|
tions should only test if the return value is ERR, since
|
|
|
|
|
the OK value (zero) is likely to be misleading. One pos-
|
|
|
|
|
sible way to get useful results would be to use a "%n"
|
|
|
|
|
conversion at the end of the format string to ensure that
|
|
|
|
|
something was processed.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
2013-12-22 07:12:46 +08:00
|
|
|
<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>
|
2002-10-13 11:35:53 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<div class="nav">
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="#h2-NAME">NAME</a></li>
|
|
|
|
|
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
|
|
|
|
|
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
|
|
|
|
|
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
|
|
|
|
|
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
|
|
|
|
|
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
2000-07-09 10:46:08 +08:00
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|
