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

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, 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 GETNSTR 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 getnstr, getstr, mvgetnstr, mvgetstr, mvwgetnstr, mvwgetstr, wgetnstr, wgetstr
   9 \- get a multibyte character string from terminal
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  14 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  15
  16 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  17
  18 #include <curses.h>
  19
  20 \fBint\fR \fBgetnstr\fR(\fBchar *\fR\fIstr\fR, \fBint\fR \fIn\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBgetstr\fR(\fBchar *\fR\fIstr\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBint\fR \fBmvgetnstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIstr\fR, \fBint\fR \fIn\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBmvgetstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIstr\fR);
  36 .fi
  37
  38 .LP
  39 .nf
  40 \fBint\fR \fBmvwgetnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIstr\fR, \fBint\fR \fIn\fR);
  41 .fi
  42
  43 .LP
  44 .nf
  45 \fBint\fR \fBmvwgetstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIstr\fR);
  46 .fi
  47
  48 .LP
  49 .nf
  50 \fBint\fR \fBwgetnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIstr\fR, \fBint\fR \fIn\fR);
  51 .fi
  52
  53 .LP
  54 .nf
  55 \fBint\fR \fBwgetstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIstr\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBgetstr()\fR and \fBwgetstr()\fR functions get a character string  from
  62 the terminal associated with the window \fBstdscr\fR or window  \fIwin\fR,
  63 respectively. The \fBmvgetstr()\fR and \fBmvwgetstr()\fR functions move the
  64 cursor to the  position specified in \fBstdscr\fR or \fIwin\fR, respectively,
  65 then get a  character string.
  66 .sp
  67 .LP
  68 These functions call \fBwgetch\fR(3XCURSES) and place each received character
  69 in \fIstr\fR until a newline is received, which is also placed in \fIstr\fR.
  70 The erase and kill characters set by the user are processed.
  71 .sp
  72 .LP
  73 The \fBgetnstr()\fR, \fBmvgetnstr()\fR, \fBmvwgetnstr()\fR and
  74 \fBwgetnstr()\fR functions read at most \fIn\fR characters.  These functions
  75 are used to prevent overflowing the input buffer.
  76 .sp
  77 .LP
  78 The \fBgetnstr()\fR, \fBwgetnstr()\fR, \fBmvgetnstr()\fR, and
  79 \fBmvwgetnstr()\fR functions only return complete multibyte characters. If the
  80 area pointed to by \fIstr\fR is not large enough to hold at least one
  81 character, these functions fail.
  82 .SH PARAMETERS
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fIstr\fR\fR
  87 .ad
  88 .RS 7n
  89 Is a pointer to the area where the character string is to be placed.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fIn\fR\fR
  96 .ad
  97 .RS 7n
  98 Is the maximum number of characters to read from input.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fIy\fR\fR
 105 .ad
 106 .RS 7n
 107 Is the y (row) coordinate of starting position of character string to be read.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fIx\fR\fR
 114 .ad
 115 .RS 7n
 116 Is the x (column) coordinate of starting position of  character string to be
 117 read.
 118 .RE
 119
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fIwin\fR\fR
 124 .ad
 125 .RS 7n
 126 Points to the window associated with the terminal from which the character  is
 127 to be read.
 128 .RE
 129
 130 .SH RETURN VALUES
 131 .sp
 132 .LP
 133 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
 134 .SH ERRORS
 135 .sp
 136 .LP
 137 None.
 138 .SH ATTRIBUTES
 139 .sp
 140 .LP
 141 See \fBattributes\fR(5) for descriptions of the following attributes:
 142 .sp
 143
 144 .sp
 145 .TS
 146 box;
 147 c | c
 148 l | l .
 149 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 150 _
 151 Interface Stability     Standard
 152 _
 153 MT-Level        Unsafe
 154 .TE
 155
 156 .SH SEE ALSO
 157 .sp
 158 .LP
 159 \fBgetch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5),
 160 \fBstandards\fR(5)