usr/src/man/man3curses/curs_getstr.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_GETSTR 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 curs_getstr, getstr, wgetstr, mvgetstr, mvwgetstr, wgetnstr \- get character
  10 strings from curses terminal keyboard
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lcurses\fR [ \fIlibrary\fR ... ]
  15 #include <curses.h>
  16
  17 \fBint\fR \fBgetstr\fR(\fBchar *\fR\fIstr\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBint\fR \fBwgetstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIstr\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBmvgetstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIstr\fR);
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBint\fR \fBmvwgetstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIstr\fR);
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBint\fR \fBwgetnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIstr\fR, \fBint\fR \fIn\fR);
  38 .fi
  39
  40 .SH DESCRIPTION
  41 .sp
  42 .LP
  43 The effect of \fBgetstr()\fR is as though a series of calls to \fBgetch()\fR
  44 were made, until a newline or carriage return is received. The resulting value
  45 is placed in the area pointed to by the character pointer \fIstr\fR.
  46 \fBwgetnstr()\fR reads at most \fIn\fR characters, thus preventing a possible
  47 overflow of the input buffer. The user's erase and kill characters are
  48 interpreted, as well as any special keys (such as function keys, HOME key, and
  49 CLEAR key.)
  50 .SH RETURN VALUES
  51 .sp
  52 .LP
  53 All routines return the integer \fBERR\fR upon failure and an integer value
  54 other than \fBERR\fR upon successful completion.
  55 .SH ATTRIBUTES
  56 .sp
  57 .LP
  58 See \fBattributes\fR(5) for descriptions of the following attributes:
  59 .sp
  60
  61 .sp
  62 .TS
  63 box;
  64 c | c
  65 l | l .
  66 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  67 _
  68 MT-Level        Unsafe
  69 .TE
  70
  71 .SH SEE ALSO
  72 .sp
  73 .LP
  74 \fBcurs_getch\fR(3CURSES), \fBcurses\fR(3CURSES), \fBattributes\fR(5)
  75 .SH NOTES
  76 .sp
  77 .LP
  78 The header <\fBcurses.h\fR> automatically includes the headers  <\fBstdio.h\fR>
  79 and <\fBunctrl.h\fR>.
  80 .sp
  81 .LP
  82 Note that \fBgetstr()\fR, \fBmvgetstr()\fR, and \fBmvwgetstr()\fR may be
  83 macros.