82 lines
4.1 KiB
Plaintext
82 lines
4.1 KiB
Plaintext
.\"***************************************************************************
|
|
.\" 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 $
|
|
.TH curs_scanw 3X ""
|
|
.SH NAME
|
|
\fBscanw\fR,
|
|
\fBwscanw\fR,
|
|
\fBmvscanw\fR,
|
|
\fBmvwscanw\fR,
|
|
\fBvwscanw\fR, \fBvw_scanw\fR - convert formatted input from a \fBcurses\fR window
|
|
.SH SYNOPSIS
|
|
\fB#include <curses.h>\fR
|
|
|
|
\fBint scanw(char *fmt\fR [\fB, arg\fR] \fB...);\fR
|
|
.br
|
|
\fBint wscanw(WINDOW *win, char *fmt\fR [\fB, arg\fR] \fB...);\fR
|
|
.br
|
|
\fBint mvscanw(int y, int x, char *fmt\fR [\fB, arg\fR] \fB...);\fR
|
|
.br
|
|
\fBint mvwscanw(WINDOW *win, int y, int x,\fR
|
|
\fBchar *fmt\fR [\fB, arg]\fR \fB...);\fR
|
|
.br
|
|
\fBint vw_scanw(WINDOW *win, char *fmt, va_list varglist);\fR
|
|
.br
|
|
\fBint vwscanw(WINDOW *win, char *fmt, va_list varglist);\fR
|
|
.SH DESCRIPTION
|
|
The \fBscanw\fR, \fBwscanw\fR and \fBmvscanw\fR routines are analogous to
|
|
\fBscanf\fR [see \fBscanf\fR(3S)]. The effect of these routines is as though
|
|
\fBwgetstr\fR were called on the window, and the resulting line used as input
|
|
for \fBsscanf\fR(3). Fields which do not map to a variable in the \fIfmt\fR
|
|
field are lost.
|
|
|
|
The \fBvwscanw\fR routine is similar to \fBvwprintw\fR in that it performs a
|
|
\fBwscanw\fR using a variable argument list. The third argument is a
|
|
\fIva\fR_\fIlist\fR, a pointer to a list of arguments, as defined in
|
|
\fB<varargs.h>\fR.
|
|
.SH RETURN VALUE
|
|
\fBvwscanw\fR returns \fBERR\fR on failure and an integer equal to the
|
|
number of fields scanned on success.
|
|
|
|
Applications may use the return value from the \fBscanw\fR, \fBwscanw\fR,
|
|
\fBmvscanw\fR and \fBmvwscanw\fR routines to determine the number of fields
|
|
which were mapped in the call.
|
|
.SH PORTABILITY
|
|
The XSI Curses standard, Issue 4 describes these functions. The function
|
|
\fBvwscanw\fR is marked TO BE WITHDRAWN, and is to be replaced by a function
|
|
\fBvw_scanw\fR using the \fB<stdarg.h>\fR interface.
|
|
.SH SEE ALSO
|
|
\fBcurses\fR(3X), \fBcurs_getstr\fR(3X), \fBcurs_printw\fR(3X), \fBscanf\fR(3S)
|
|
.\"#
|
|
.\"# The following sets edit modes for GNU EMACS
|
|
.\"# Local Variables:
|
|
.\"# mode:nroff
|
|
.\"# fill-column:79
|
|
.\"# End:
|