curs_scanw(3ocurses)

curs_scanw: scanw, wscanw, mvscanw, mvwscanw, vwscanw -- convert formatted input from a curses window

Synopsis

cc [flag . . .] file -locurses [library . . .]

#include <ocurses.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 vwscanw(WINDOW win, char fmt, va_list varglist);

Description

The scanw, wscanw and mvscanw routines correspond to scanf [see fscanf(3S)]. The effect of these routines is as though wgetstr were called on the window, and the resulting line used as input for the scan. 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 values

vwscanw returns ERR on failure and an integer equal to the number of fields scanned on success.

Applications may interrogate the return value from the scanw, wscanw, mvscanw and mvwscanw routines to determine the number of fields which were mapped in the call.

References

curses(3ocurses), curs_getstr(3ocurses), curs_printw(3ocurses), fscanf(3S)

Notices

The header file ocurses.h automatically includes the header files stdio.h and unctrl.h.