X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_scanw.3x.html;h=b6331f0935c2ce0ad0abd1cc20bdb5297cc28039;hp=7d81e69e931cf3102bcb18a15b0376efe4df5bdc;hb=bca50d0d8592defee6c584fdedd25f4b1a31345b;hpb=a8e3f06ac309504143cd56ac9ec55889bfdf4914 diff --git a/doc/html/man/curs_scanw.3x.html b/doc/html/man/curs_scanw.3x.html index 7d81e69e..b6331f09 100644 --- a/doc/html/man/curs_scanw.3x.html +++ b/doc/html/man/curs_scanw.3x.html @@ -26,13 +26,13 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_scanw.3x,v 1.18 2017/04/17 00:07:02 tom Exp @ + * @Id: curs_scanw.3x,v 1.19 2017/11/21 00:46:31 tom Exp @ -->
- +-curs_scanw(3x) curs_scanw(3x) +curs_scanw(3x) curs_scanw(3x)
- scanw, wscanw, mvscanw, mvwscanw, vwscanw, vw_scanw - con- - vert formatted input from a curses window + scanw, wscanw, mvscanw, mvwscanw, vwscanw, vw_scanw - convert formatted + input from a curses window
@@ -62,53 +62,48 @@
- The scanw, wscanw and mvscanw routines are analogous to - scanf [see scanf(3)]. The effect of these routines is as - though wgetstr were called on the window, and the result- - ing line used as input for sscanf(3). Fields which do not - map to a variable in the fmt field are lost. + The scanw, wscanw and mvscanw routines are analogous to scanf [see + scanf(3)]. The effect of these routines is as though wgetstr were + called on the window, and the resulting line used as input for + sscanf(3). Fields which do not map to a variable in the fmt field are + lost. - The vwscanw and vw_scanw routines are analogous to - vscanf(3). They perform a wscanw using a variable argu- - ment list. The third argument is a va_list, a pointer to - a list of arguments, as defined in <stdarg.h>. + The vwscanw and vw_scanw routines are analogous to vscanf(3). They + perform a wscanw using a variable argument list. The third argument is + a va_list, a pointer to a list of arguments, as defined in <stdarg.h>.
- vwscanw returns ERR on failure and an integer equal to the - number of fields scanned on success. + vwscanw returns ERR on failure and an integer equal to the number of + fields scanned on success. - Applications may use the return value from the scanw, - wscanw, mvscanw and mvwscanw routines to determine the - number of fields which were mapped in the call. + Applications may use the return value from the scanw, wscanw, mvscanw + and mvwscanw 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 wmove, 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 + wmove, and return an error if the position is outside the window, or if + the window pointer is null.
- The XSI Curses standard, Issue 4 describes these func- - tions. The function vwscanw is marked TO BE WITHDRAWN, - and is to be replaced by a function vw_scanw using the - <stdarg.h> interface. The Single Unix Specification, Ver- - sion 2 states that vw_scanw is preferred to vwscanw since - the latter requires including <varargs.h>, which cannot be - used in the same file as <stdarg.h>. This implementation - uses <stdarg.h> for both, because that header is included - in <curses.h>. - - Both XSI and The Single Unix Specification, Version 2 - state that these functions return ERR or OK. Since the - underlying scanf(3) 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 vwscanw is marked TO BE WITHDRAWN, and is to be replaced by a + function vw_scanw using the <stdarg.h> interface. The Single Unix + Specification, Version 2 states that vw_scanw is preferred to vwscanw + since the latter requires including <varargs.h>, which cannot be used + in the same file as <stdarg.h>. This implementation uses <stdarg.h> + for both, because that header is included in <curses.h>. + + Both XSI and The Single Unix Specification, Version 2 state that these + functions return ERR or OK. Since the underlying scanf(3) 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.
@@ -116,7 +111,7 @@ - curs_scanw(3x) + curs_scanw(3x)