<BODY>
<H1 class="no-header">curs_scanw 3x</H1>
<PRE>
-<STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG> <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG>
+<STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG>
<STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <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
+ <STRONG>scanw</STRONG>, <STRONG>wscanw</STRONG>, <STRONG>mvscanw</STRONG>, <STRONG>mvwscanw</STRONG>, <STRONG>vwscanw</STRONG>, <STRONG>vw_scanw</STRONG> - convert formatted
+ input from a <STRONG>curses</STRONG> window
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- The <STRONG>scanw</STRONG>, <STRONG>wscanw</STRONG> and <STRONG>mvscanw</STRONG> routines are analogous to
- <STRONG>scanf</STRONG> [see <STRONG>scanf(3)</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>sscanf(3)</STRONG>. Fields which do not
- map to a variable in the <EM>fmt</EM> field are lost.
+ The <STRONG>scanw</STRONG>, <STRONG>wscanw</STRONG> and <STRONG>mvscanw</STRONG> routines are analogous to <STRONG>scanf</STRONG> [see
+ <STRONG>scanf(3)</STRONG>]. The effect of these routines is as though <STRONG>wgetstr</STRONG> were
+ called on the window, and the resulting line used as input for
+ <STRONG>sscanf(3)</STRONG>. Fields which do not map to a variable in the <EM>fmt</EM> field are
+ lost.
- The <STRONG>vwscanw</STRONG> and <STRONG>vw_scanw</STRONG> routines are analogous to
- <STRONG>vscanf(3)</STRONG>. They perform a <STRONG>wscanw</STRONG> using a variable argu-
- ment list. The third argument is a <EM>va</EM><STRONG>_</STRONG><EM>list</EM>, a pointer to
- a list of arguments, as defined in <STRONG><stdarg.h></STRONG>.
+ The <STRONG>vwscanw</STRONG> and <STRONG>vw_scanw</STRONG> routines are analogous to <STRONG>vscanf(3)</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 arguments, as defined in <STRONG><stdarg.h></STRONG>.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- <STRONG>vwscanw</STRONG> returns <STRONG>ERR</STRONG> on failure and an integer equal to the
- number of fields scanned on success.
+ <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 <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.
+ 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.
- 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.
+ Functions with a "mv" prefix first perform a cursor movement using
+ <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
+ the window pointer is null.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- The XSI Curses standard, Issue 4 describes these func-
- 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(3)</STRONG> can return the number of items
- scanned, and the SVr4 code was documented to use this fea-
- ture, this is probably an editing error which was intro-
- duced in XSI, rather than being done intentionally. Por-
- table applications should only test if the return value is
- ERR, since the OK value (zero) is likely to be misleading.
- One possible 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.
+ The XSI Curses standard, Issue 4 describes these functions. The func-
+ tion <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, Version 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(3)</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 applications
+ should only test if the return value is ERR, since the OK value (zero)
+ is likely to be misleading. One possible 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><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG>
+
<STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
projects / ncurses.git / blobdiff