X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_scanw.3x.html;h=b6331f0935c2ce0ad0abd1cc20bdb5297cc28039;hb=f4ed859493ee1d227b3b51cfe88ec635f0dcb099;hp=48e8e9f7fcd2c900eecae61e0ef917cf5c427634;hpb=0ac2306dd3aaab1338d8b1458c15a7e476cfc3ff;p=ncurses.git diff --git a/doc/html/man/curs_scanw.3x.html b/doc/html/man/curs_scanw.3x.html index 48e8e9f7..b6331f09 100644 --- a/doc/html/man/curs_scanw.3x.html +++ b/doc/html/man/curs_scanw.3x.html @@ -1,7 +1,6 @@ - +
+ +- -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 --
+
#include <curses.h> int scanw(char *fmt, ...); @@ -63,71 +61,67 @@ int vwscanw(WINDOW *win, char *fmt, va_list varglist); --
- 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. - They perform a wscanw using a variable argument list. The - third argument is a va_list, a pointer to a list of argu- - ments, 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 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. +
+ 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. --
- curses(3x), curs_getstr(3x), curs_printw(3x), scanf(3) + +
+ curses(3x), curs_getstr(3x), curs_printw(3x), scanf(3) - curs_scanw(3x) + curs_scanw(3x)-