Current File : //usr/man/man3xcurses/vw_scanw.3xcurses

'\" te
.\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
.TH vw_scanw 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions"
.SH NAME
vw_scanw \- convert formatted input from a window
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]

\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]

#include <stdarg.h>
#include <curses.h>

\fBint\fR \fBvw_scanw\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIfmt\fR, \fBva_list\fR \fIvarglist\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIfmt\fR\fR
.ad
.RS 12n
.rt  
Is a \fBscanf()\fR format string. 
.RE

.sp
.ne 2
.mk
.na
\fB\fIvarglist\fR\fR
.ad
.RS 12n
.rt  
Is a pointer to a list of parameters.
.RE

.sp
.ne 2
.mk
.na
\fB\fIwin\fR\fR
.ad
.RS 12n
.rt  
Is a pointer to the window in which the character is to be read.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBvw_scanw()\fR function achieves the same effect as \fBwscanw\fR(3XCURSES) using a variable argument list. The third argument is a \fBva_list\fR, as defined in <\fBstdarg.h\fR>.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, \fBvw_scanw()\fR returns \fBOK\fR. Otherwise, it returns \fBERR\fR.
.SH ERRORS
.sp
.LP
No errors are defined.
.SH USAGE
.sp
.LP
The \fBvw_scanw()\fR function is preferred over \fBvwscanw\fR(3XCURSES). The use of the \fBvwscanw()\fR and \fBvw_scanw()\fR in the same file will not work, due to the requirements to include <\fBvarargs.h\fR> and <\fBstdarg.h\fR>, which both contain definitions of \fBva_list\fR.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelUnsafe
_
StandardSee \fBstandards\fR(5).
.TE

.SH SEE ALSO
.sp
.LP
\fBlibcurses\fR(3XCURSES), \fBmvscanw\fR(3XCURSES), \fBscanf\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)