usr/src/man/man3xcurses/getn_wstr.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 GETN_WSTR 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 getn_wstr, get_wstr, mvgetn_wstr, mvget_wstr, mvwgetn_wstr, mvwget_wstr,
   9 wgetn_wstr, wget_wstr \- get a wide 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 \fBgetn_wstr\fR(\fBwint_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBget_wstr\fR(\fBwint_t *\fR\fIwstr\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBint\fR \fBmvgetn_wstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwint_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBmvget_wstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwint_t *\fR\fIwstr\fR);
  36 .fi
  37
  38 .LP
  39 .nf
  40 \fBint\fR \fBmvwgetn_wstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwint_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR);
  41 .fi
  42
  43 .LP
  44 .nf
  45 \fBint\fR \fBmvwget_wstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwint_t *\fR\fIwstr\fR);
  46 .fi
  47
  48 .LP
  49 .nf
  50 \fBint\fR \fBwgetn_wstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBwint_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR);
  51 .fi
  52
  53 .LP
  54 .nf
  55 \fBint\fR \fBwget_wstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBwint_t *\fR\fIwstr\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBget_wstr()\fR and \fBwget_wstr()\fR functions get a wide character
  62 string from the terminal associated with the window \fBstdscr\fR or window
  63 \fIwin\fR, respectively. The \fBmvget_str()\fR and \fBmvwget_wstr()\fR
  64 functions move the cursor to  the position specified in \fBstdscr\fR or
  65 \fIwin\fR, respectively, then get a  wide character string.
  66 .sp
  67 .LP
  68 These functions call \fBwget_wch\fR(3XCURSES) and place each received character
  69 in \fIwstr\fR until a newline character, end-of-line character, or end-of-file
  70 character is received, which is also placed in \fIwstr\fR. The erase and kill
  71 characters set by the user are processed.
  72 .sp
  73 .LP
  74 The \fBgetn_wstr()\fR, \fBmvgetn_wstr()\fR, \fBmvwgetn_wstr()\fR and
  75 \fBwgetn_wstr()\fR functions read at most \fIn\fR characters.  These functions
  76 are used to prevent overflowing the input buffer.
  77 .SH PARAMETERS
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fIwstr\fR\fR
  82 .ad
  83 .RS 8n
  84 Is a pointer to the area where the character string is to be placed.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fIn\fR\fR
  91 .ad
  92 .RS 8n
  93 Is the maximum number of characters to read from input.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fIy\fR\fR
 100 .ad
 101 .RS 8n
 102 Is the y (row) coordinate of starting position of character string to be read.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fIx\fR\fR
 109 .ad
 110 .RS 8n
 111 Is the x (column) coordinate of starting position of  character string to be
 112 read.
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fIwin\fR\fR
 119 .ad
 120 .RS 8n
 121 points to the window associated with the terminal from which the character  is
 122 to be read.
 123 .RE
 124
 125 .SH RETURN VALUES
 126 .sp
 127 .LP
 128 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
 129 .SH ERRORS
 130 .sp
 131 .LP
 132 None.
 133 .SH ATTRIBUTES
 134 .sp
 135 .LP
 136 See \fBattributes\fR(5) for descriptions of the following attributes:
 137 .sp
 138
 139 .sp
 140 .TS
 141 box;
 142 c | c
 143 l | l .
 144 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 145 _
 146 Interface Stability     Standard
 147 _
 148 MT-Level        Unsafe
 149 .TE
 150
 151 .SH SEE ALSO
 152 .sp
 153 .LP
 154 \fBget_wch\fR(3XCURSES), \fBgetnstr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
 155 \fBattributes\fR(5), \fBstandards\fR(5)