usr/src/man/man3xcurses/mvscanw.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH MVSCANW 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 mvscanw, mvwscanw, scanw, wscanw \- convert formatted input from a window
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBint\fR \fBmvscanw\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIfmt\fR, \fB\&.\|.\|.\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBmvwscanw\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIfmt\fR, \fB\&.\|.\|.\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBint\fR \fBscanw\fR(\fBchar *\fR\fIfmt\fR, \fB\&.\|.\|.\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBint\fR \fBwscanw\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIfmt\fR, \fB\&.\|.\|.\fR);
  35 .fi
  36
  37 .SH PARAMETERS
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fIy\fR\fR
  42 .ad
  43 .RS 7n
  44 Is the y (row) coordinate of the position of the character to be read.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fIx\fR\fR
  51 .ad
  52 .RS 7n
  53 Is the x (column) coordinate of the position of the character to be read.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fIfmt\fR\fR
  60 .ad
  61 .RS 7n
  62 Is a \fBscanf()\fR format string.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fIwin\fR\fR
  69 .ad
  70 .RS 7n
  71 Is a pointer to the window in which the character is to be read.
  72 .RE
  73
  74 .SH DESCRIPTION
  75 .sp
  76 .LP
  77 These functions are similar to \fBscanf\fR(3C). Their effect is as though
  78 \fBmvwgetstr\fR(3XCURSES) were called to get a multi-byte character string from
  79 the current or specified window at the current or specified cursor position,
  80 and then \fBsscanf()\fR were used to interpret and convert that string.
  81 .SH RETURN VALUES
  82 .sp
  83 .LP
  84 Upon successful completion, these functions return \fBOK\fR. Otherwise, they
  85 return \fBERR\fR.
  86 .SH ERRORS
  87 .sp
  88 .LP
  89 No errors are defined.
  90 .SH ATTRIBUTES
  91 .sp
  92 .LP
  93 See \fBattributes\fR(5) for descriptions of the following attributes:
  94 .sp
  95
  96 .sp
  97 .TS
  98 box;
  99 c | c
 100 l | l .
 101 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 102 _
 103 Interface Stability     Standard
 104 _
 105 MT-Level        Unsafe
 106 .TE
 107
 108 .SH SEE ALSO
 109 .sp
 110 .LP
 111 \fBgetnstr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBprintw\fR(3XCURSES),
 112 \fBscanf\fR(3C), \fBwcstombs\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)