X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_scanw.3x.html;h=7d81e69e931cf3102bcb18a15b0376efe4df5bdc;hp=ca8fe63161140fc9c1c13310a6d59db2d5a64b99;hb=a8e3f06ac309504143cd56ac9ec55889bfdf4914;hpb=027d0c57c4c4d6690e8d8727888d3282dbe9aa86 diff --git a/doc/html/man/curs_scanw.3x.html b/doc/html/man/curs_scanw.3x.html index ca8fe631..7d81e69e 100644 --- a/doc/html/man/curs_scanw.3x.html +++ b/doc/html/man/curs_scanw.3x.html @@ -1,6 +1,6 @@ @@ -45,14 +45,12 @@ - -
+
scanw, wscanw, mvscanw, mvwscanw, vwscanw, vw_scanw - con- vert formatted input from a curses window --
+
#include <curses.h> int scanw(char *fmt, ...); @@ -63,22 +61,20 @@ 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 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 argu- + ment 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. @@ -91,8 +87,7 @@ 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 @@ -105,19 +100,18 @@ 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. - - --
+ 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. + + +
curses(3x), curs_getstr(3x), curs_printw(3x), scanf(3)