1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
'\" te
.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved
.\" 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.
.\" 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.
.\" 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]
.TH getn_wstr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions"
.SH NAME
getn_wstr, get_wstr, mvgetn_wstr, mvget_wstr, mvwgetn_wstr, mvwget_wstr,
wgetn_wstr, wget_wstr \- get a wide character string from terminal
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
#include <curses.h>
\fBint\fR \fBgetn_wstr\fR(\fBwint_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR);
.fi
.LP
.nf
\fBint\fR \fBget_wstr\fR(\fBwint_t *\fR\fIwstr\fR);
.fi
.LP
.nf
\fBint\fR \fBmvgetn_wstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwint_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR);
.fi
.LP
.nf
\fBint\fR \fBmvget_wstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwint_t *\fR\fIwstr\fR);
.fi
.LP
.nf
\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);
.fi
.LP
.nf
\fBint\fR \fBmvwget_wstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwint_t *\fR\fIwstr\fR);
.fi
.LP
.nf
\fBint\fR \fBwgetn_wstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBwint_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR);
.fi
.LP
.nf
\fBint\fR \fBwget_wstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBwint_t *\fR\fIwstr\fR);
.fi
.SH DESCRIPTION
.sp
.LP
The \fBget_wstr()\fR and \fBwget_wstr()\fR functions get a wide character
string from the terminal associated with the window \fBstdscr\fR or window
\fIwin\fR, respectively. The \fBmvget_str()\fR and \fBmvwget_wstr()\fR
functions move the cursor to the position specified in \fBstdscr\fR or
\fIwin\fR, respectively, then get a wide character string.
.sp
.LP
These functions call \fBwget_wch\fR(3XCURSES) and place each received character
in \fIwstr\fR until a newline character, end-of-line character, or end-of-file
character is received, which is also placed in \fIwstr\fR. The erase and kill
characters set by the user are processed.
.sp
.LP
The \fBgetn_wstr()\fR, \fBmvgetn_wstr()\fR, \fBmvwgetn_wstr()\fR and
\fBwgetn_wstr()\fR functions read at most \fIn\fR characters. These functions
are used to prevent overflowing the input buffer.
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIwstr\fR\fR
.ad
.RS 8n
.rt
Is a pointer to the area where the character string is to be placed.
.RE
.sp
.ne 2
.mk
.na
\fB\fIn\fR\fR
.ad
.RS 8n
.rt
Is the maximum number of characters to read from input.
.RE
.sp
.ne 2
.mk
.na
\fB\fIy\fR\fR
.ad
.RS 8n
.rt
Is the y (row) coordinate of starting position of character string to be read.
.RE
.sp
.ne 2
.mk
.na
\fB\fIx\fR\fR
.ad
.RS 8n
.rt
Is the x (column) coordinate of starting position of character string to be
read.
.RE
.sp
.ne 2
.mk
.na
\fB\fIwin\fR\fR
.ad
.RS 8n
.rt
points to the window associated with the terminal from which the character is
to be read.
.RE
.SH RETURN VALUES
.sp
.LP
On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
.SH ERRORS
.sp
.LP
None.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i)
lw(2.75i) |lw(2.75i)
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityStandard
_
MT-LevelUnsafe
.TE
.SH SEE ALSO
.sp
.LP
\fBget_wch\fR(3XCURSES), \fBgetnstr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
\fBattributes\fR(5), \fBstandards\fR(5)
|
