xref: /illumos-gate/usr/src/man/man3xcurses/mvscanw.3xcurses (revision a28480febf31f0e61debac062a55216a98a05a92)
te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
MVSCANW 3XCURSES "Jun 5, 2002"
NAME
mvscanw, mvwscanw, scanw, wscanw - convert formatted input from a window
SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \e
 -R  /usr/xpg4/lib  -lcurses  [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

int mvscanw(int y, int x, char *fmt, .\|.\|.);

int mvwscanw(WINDOW *win, int y, int x, char *fmt, .\|.\|.);

int scanw(char *fmt, .\|.\|.);

int wscanw(WINDOW *win, char *fmt, .\|.\|.);
PARAMETERS
y

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

x

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

fmt

Is a scanf() format string.

win

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

DESCRIPTION

These functions are similar to scanf(3C). Their effect is as though mvwgetstr(3XCURSES) were called to get a multi-byte character string from the current or specified window at the current or specified cursor position, and then sscanf() were used to interpret and convert that string.

RETURN VALUES

Upon successful completion, these functions return OK. Otherwise, they return ERR.

ERRORS

No errors are defined.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level Unsafe
SEE ALSO

getnstr(3XCURSES), libcurses(3XCURSES), printw(3XCURSES), scanf(3C), wcstombs(3C), attributes(5), standards(5)