+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<!--
+ ****************************************************************************
+ * Copyright (c) 1998,2000 Free Software Foundation, Inc. *
+ * *
+ * 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. *
+ ****************************************************************************
+ * @Id: curs_scanw.3x,v 1.12 2002/07/20 15:48:09 tom Exp @
+-->
<HTML>
+<HEAD>
+<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>
<BODY>
+<H1>curs_scanw 3x</H1>
+<HR>
<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
+ <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
</PRE>
<H2>SYNOPSIS</H2><PRE>
- <B>#include</B> <B><curses.h></B>
+ <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
- <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>
+ <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>
</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 <STRONG>scanw</STRONG>, <STRONG>wscanw</STRONG> and <STRONG>mvscanw</STRONG> routines are analogous to
+ <STRONG>scanf</STRONG> [see <STRONG><A HREF="scanf.3S.html">scanf(3S)</A></STRONG>]. The effect of these routines is as
+ though <STRONG>wgetstr</STRONG> were called on the window, and the result-
+ ing line used as input for <STRONG><A HREF="sscanf.3.html">sscanf(3)</A></STRONG>. Fields which do not
+ map to a variable in the <EM>fmt</EM> 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><varargs.h></B>.
+ 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>.
</PRE>
<H2>RETURN VALUE</H2><PRE>
- <B>vwscanw</B> returns <B>ERR</B> on failure and an integer equal to the
+ <STRONG>vwscanw</STRONG> returns <STRONG>ERR</STRONG> 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
+ 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
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><stdarg.h></B> interface.
+ 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.
</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>
+ <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>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
projects / ncurses.git / blobdiff