xref: /freebsd/contrib/ncurses/man/curs_scanw.3x (revision 2a4a1db342263067035ce69a4017c645da63455d)
***************************************************************************
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.11 2000/07/15 21:48:17 tom Exp $
curs_scanw 3X ""
NAME
scanw, wscanw, mvscanw, mvwscanw, vwscanw, vw_scanw - convert formatted input from a curses window
SYNOPSIS
#include <curses.h> int scanw(char *fmt [, arg] ...);

int wscanw(WINDOW *win, char *fmt [, arg] ...);

int mvscanw(int y, int x, char *fmt [, arg] ...);

int mvwscanw(WINDOW *win, int y, int x, char *fmt [, arg] ...);

int vw_scanw(WINDOW *win, char *fmt, va_list varglist);

int vwscanw(WINDOW *win, char *fmt, va_list varglist);

DESCRIPTION
The scanw, wscanw and mvscanw routines are analogous to scanf [see scanf(3S)]. 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 routine is similar to vwprintw in that it performs a wscanw using a variable argument list. The third argument is a va_list, a pointer to a list of arguments, as defined in <varargs.h>.
RETURN VALUE
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.
PORTABILITY
The XSI Curses standard, Issue 4 describes these functions. The function vwscanw is marked TO BE WITHDRAWN, and is to be replaced by a function vw_scanw using the <stdarg.h> interface.
SEE ALSO
curses(3X), curs_getstr(3X), curs_printw(3X), scanf(3S) #
# The following sets edit modes for GNU EMACS
# Local Variables:
# mode:nroff
# fill-column:79
# End: