lib/libcurses/curses_scanw.3

   1 .\"     $NetBSD: curses_scanw.3,v 1.4 2003/02/14 16:29:12 grant 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 .In curses.h
  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
  56 These functions read formatted data from
  57 .Dv stdscr
  58 or from the specified window.
  59 .Pp
  60 The
  61 .Fn scanw
  62 function is the same as the
  63 .Fn scanf
  64 function, excepting that the input data stream is read from the current
  65 cursor position on
  66 .Dv stdscr ,
  67 .Pp
  68 The
  69 .Fn wscanw
  70 function is the same
  71 as the
  72 .Fn scanw
  73 function, excepting that the data stream is read from the window specified by
  74 .Fa win .
  75 .Pp
  76 The
  77 .Fn mvscanw
  78 and
  79 .Fn mvwscanw
  80 functions are the same as the
  81 .Fn scanw
  82 and
  83 .Fn mvscanw
  84 functions, respectively, excepting that
  85 .Fn wmove
  86 is called to move the cursor to the position specified by
  87 .Fa y ,
  88 .Fa x
  89 before the data is read from the window.
  90 .Sh RETURN VALUES
  91 Functions returning pointers will return
  92 .Dv NULL
  93 if an error is detected.
  94 The functions that return an int will return one of the following
  95 values:
  96 .Pp
  97 .Bl -tag -width ERR -compact
  98 .It Er OK
  99 The function completed successfully.
 100 .It Er ERR
 101 An 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
 108 The
 109 .Nx
 110 Curses library complies with the X/Open Curses specification, part of the
 111 Single Unix Specification.
 112 .Sh HISTORY
 113 The Curses package appeared in
 114 .Bx 4.0 .