mvscanw(3XC)

NAME

mvscanw, mvwscanw, scanw, vw_scanw, vwscanw, wscanw − read formatted input from window

SYNOPSIS

#include <curses.h>

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

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

int scanw(char ∗fmt [,arg...]);

int vwscanw(WINDOW ∗win, char ∗fmt, void ∗arglist);

int vw_scanw(WINDOW ∗win, char ∗fmt, void ∗arglist);

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

ARGUMENTS

yIs the y (row) coordinate of the position of the character to be read.

xIs the x (column) coordinate of the position of the character to be read.

fmt [,arg...]
fmt is a vwscanw() format string; arg is zero or more parameters used to satisfy the scanf() string.

winIs a pointer to the window in which the character is to be read.

fmt, arglist
fmt is a scanf() format string; arglist is a pointer to zero or more parameters used to satisfy the scanf() string. The vwprintw() function requires a variable parameter list as defined in <varargs.h>. The vw_printw() function requires a variable parameter list as defined in <stdarg.h>.

DESCRIPTION

These functions are functionally equivalent to scanf(3S). Characters are read from the window using the getstr(3XC) set of functions. When a newline is received, the line is processed by scanw() which places the result in the appropriate args.

With scanw() and wscanw(), the characters are read from stdscr and win, respectively. The mvscanw() and mvwscanw() functions position the cursor in the window and then call scanw().

The vwscanw() and vw_scanw() functions are similar to wscanw() but use a pointer to a variable parameter list as defined by either <varargs.h> or <stdarg.h>. Each application must include the appropriate header.

RETURN VALUES

On success, these functions return OK. Otherwise, they return ERR.

ERRORS

None

Museum

Related Articles