1.\" $NetBSD: curses_scanw.3,v 1.3 2002/10/21 14:33:49 wiz Exp $ 2.\" 3.\" Copyright (c) 2002 4.\" Brett Lymn (blymn@netbsd.org, brett_lymn@yahoo.com.au) 5.\" 6.\" This code is donated to the NetBSD Foundation by the Author. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. The name of the Author may not be used to endorse or promote 17.\" products derived from this software without specific prior written 18.\" permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" 33.Dd August 12, 2002 34.Dt CURSES_SCANW 3 35.Os 36.Sh NAME 37.Nm curses_scanw , 38.Nm scanw , 39.Nm wscanw , 40.Nm mvscanw , 41.Nm mvwscanw 42.Nd curses read formatted data from screen routines 43.Sh LIBRARY 44.Lb libcurses 45.Sh SYNOPSIS 46.Fd #include \*[Lt]curses.h\*[Gt] 47.Ft int 48.Fn scanw "const char *fmt" "..." 49.Ft int 50.Fn wscanw "WINDOW *win" "const char *fmt" "..." 51.Ft int 52.Fn mvscanw "int y" "int x" "const char *fmt" "..." 53.Ft int 54.Fn mvwscanw "WINDOW *win" "int y" "int x" "const char *fmt" "..." 55.Sh DESCRIPTION 56These functions read formatted data from 57.Dv stdscr 58or from the specified window. 59.Pp 60The 61.Fn scanw 62function is the same as the 63.Fn scanf 64function, excepting that the input data stream is read from the current 65cursor position on 66.Dv stdscr , 67.Pp 68The 69.Fn wscanw 70function is the same 71as the 72.Fn scanw 73function, excepting that the data stream is read from the window specified by 74.Fa win . 75.Pp 76The 77.Fn mvscanw 78and 79.Fn mvwscanw 80functions are the same as the 81.Fn scanw 82and 83.Fn mvscanw 84functions, respectively, excepting that 85.Fn wmove 86is called to move the cursor to the position specified by 87.Fa y , 88.Fa x 89before the data is read from the window. 90.Sh RETURN VALUES 91Functions returning pointers will return 92.Dv NULL 93if an error is detected. 94The functions that return an int will return one of the following 95values: 96.Pp 97.Bl -tag -width ERR -compact 98.It Er OK 99The function completed successfully. 100.It Er ERR 101An error occurred in the function. 102.El 103.Sh SEE ALSO 104.Xr curses_cursor 3 , 105.Xr curses_print 3 , 106.Xr scanf 3 107.Sh STANDARDS 108The 109.Nx 110Curses library complies with the X/Open Curses specification, part of the 111Single Unix Specification. 112.Sh HISTORY 113The Curses package appeared in 114.Bx 4.0 . 115