ncurses 6.2 - patch 20210911
[ncurses.git] / man / curs_inwstr.3x
1 .\"***************************************************************************
2 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
3 .\" Copyright 2002-2012,2017 Free Software Foundation, Inc.                  *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: curs_inwstr.3x,v 1.14 2020/10/17 23:22:11 tom Exp $
31 .TH curs_inwstr 3X ""
32 .ie \n(.g .ds `` \(lq
33 .el       .ds `` ``
34 .ie \n(.g .ds '' \(rq
35 .el       .ds '' ''
36 .SH NAME
37 \fBinwstr\fR,
38 \fBinnwstr\fR,
39 \fBwinwstr\fR,
40 \fBwinnwstr\fR,
41 \fBmvinwstr\fR,
42 \fBmvinnwstr\fR,
43 \fBmvwinwstr\fR,
44 \fBmvwinnwstr\fR \- get a string of \fBwchar_t\fR characters from a curses window
45 .SH SYNOPSIS
46 .nf
47 \fB#include <curses.h> \fR
48 .sp
49 \fBint inwstr(\fR\fBwchar_t *\fR\fIwstr\fR\fB);\fR
50 .br
51 \fBint innwstr(\fR\fBwchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR
52 .br
53 \fBint winwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, wchar_t *\fR\fIwstr\fR\fB);\fR
54 .br
55 \fBint winnwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR
56 .sp
57 \fBint mvinwstr(\fR\fBint \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIwstr\fR\fB);\fR
58 .br
59 \fBint mvinnwstr(\fR\fBint \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR
60 .br
61 \fBint mvwinwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIwstr\fR\fB);\fR
62 .br
63 \fBint mvwinnwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR
64 .fi
65 .SH DESCRIPTION
66 .PP
67 These routines return a string of \fBwchar_t\fR wide characters in \fIwstr\fR,
68 extracted starting at the current cursor position in the named window.
69 .PP
70 The four functions with \fIn\fR as the last argument return
71 a leading substring at most \fIn\fR characters long
72 (exclusive of the trailing NUL).
73 Transfer stops at the end of the current line, or when \fIn\fR characters have
74 been stored at the location referenced by \fIwstr\fR.
75 .PP
76 If the size \fIn\fR is not large enough to store a complete complex character,
77 an error is generated.
78 .SH NOTES
79 .PP
80 All routines except
81 \fBwinnwstr\fR
82 may be macros.
83 .PP
84 Each cell in the window holds a complex character (i.e., base-
85 and combining-characters) together with attributes and color.
86 These functions store only the wide characters,
87 ignoring attributes and color.
88 Use \fBin_wchstr\fP to return the complex characters from a window.
89 .SH RETURN VALUE
90 All routines return
91 \fBERR\fR
92 upon failure.
93 Upon
94 successful completion, the *\fBinwstr\fR
95 routines return
96 \fBOK\fR, and the *\fBinnwstr\fR
97 routines return the
98 number of characters read into the string.
99 .PP
100 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
101 \fBwmove\fP, and return an error if the position is outside the window,
102 or if the window pointer is null.
103 .SH SEE ALSO
104 \fBcurses\fR(3X),
105 \fBcurs_instr\fR(3X),
106 \fBcurs_in_wchstr\fR(3X)