usr/src/man/man3curses/curs_getwstr.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH CURS_GETWSTR 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 curs_getwstr, getwstr, getnwstr, wgetwstr, wgetnwstr, mvgetwstr, mvgetnwstr,
  10 mvwgetwstr, mvwgetnwstr \- get wchar_t character strings from curses terminal
  11 keyboard
  12 .SH SYNOPSIS
  13 .LP
  14 .nf
  15 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lcurses\fR [ \fIlibrary\fR .. ]
  16 #include <curses.h>
  17
  18 \fBint\fR \fBgetwstr\fR(\fBwchar_t *\fR\fIwstr\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint\fR \fBgetnwstr\fR(\fBwchar_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBint\fR \fBwgetwstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBwchar_t *\fR\fIwstr\fR);
  29 .fi
  30
  31 .LP
  32 .nf
  33 \fBint\fR \fBwgetnwstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBwchar_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR);
  34 .fi
  35
  36 .LP
  37 .nf
  38 \fBint\fR \fBmvgetwstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwchar_t *\fR\fIwstr\fR);
  39 .fi
  40
  41 .LP
  42 .nf
  43 \fBint\fR \fBmvgetnwstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwchar_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR);
  44 .fi
  45
  46 .LP
  47 .nf
  48 \fBint\fR \fBmvwgetwstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwchar_t *\fR\fIwstr\fR);
  49 .fi
  50
  51 .LP
  52 .nf
  53 \fBint\fR \fBmvwgetnwstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwchar_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR);
  54 .fi
  55
  56 .SH DESCRIPTION
  57 .sp
  58 .LP
  59 The effect of  \fBgetwstr()\fR is as though a series of calls to
  60 \fBgetwch\fR(3CURSES) were made, until a newline and carriage return is
  61 received. The resulting value is placed in the area pointed to by the
  62 \fBwchar_t\fR pointer  \fIwstr\fR. \fBgetnwstr()\fR reads at most \fIn\fR
  63 \fBwchar_t\fR characters, thus preventing a possible overflow of the input
  64 buffer. The user's erase and kill characters are interpreted, as well as any
  65 special keys (such as function keys, HOME key, CLEAR key, etc.).
  66 .SH RETURN VALUE
  67 .sp
  68 .LP
  69 All routines return the integer \fBERR\fR upon failure and an integer value
  70 other than \fBERR\fR upon successful completion.
  71 .SH ATTRIBUTES
  72 .sp
  73 .LP
  74 See \fBattributes\fR(5) for a description of the following attributes:
  75 .sp
  76
  77 .sp
  78 .TS
  79 box;
  80 c | c
  81 l | l .
  82 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  83 _
  84 MT-Level        Unsafe
  85 .TE
  86
  87 .SH SEE ALSO
  88 .sp
  89 .LP
  90 \fBcurses\fR(3CURSES), \fBgetwch\fR(3CURSES), \fBattributes\fR(5)
  91 .SH NOTES
  92 .sp
  93 .LP
  94 The header file  <\fBcurses.h\fR> automatically includes the header files
  95 <\fBstdio.h\fR>, <\fBunctrl.h\fR>, and <\fBwidec.h\fR>.
  96 .sp
  97 .LP
  98 Note that all routines except  \fBwgetnwstr()\fR may be macros.