Debian Codegraph @

upstream/debian-trixie/man3/in_wchstr.3ncurses

raw
1 .\"***************************************************************************
2 .\" Copyright 2018-2024,2025 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_in_wchstr.3x,v 1.48 2025/02/01 22:54:32 tom Exp $
31 .TH in_wchstr 3NCURSES 2025-02-01 "ncurses 6.5" "Library calls"
32 .ie \n(.g \{\
33 .ds `` \(lq
34 .ds '' \(rq
35 .\}
36 .el \{\
37 .ie t .ds `` ``
38 .el .ds `` ""
39 .ie t .ds '' ''
40 .el .ds '' ""
41 .\}
42 .
43 .de bP
44 .ie n .IP \(bu 4
45 .el .IP \(bu 2
46 ..
47 .SH NAME
48 \fB\%in_wchstr\fP,
49 \fB\%in_wchnstr\fP,
50 \fB\%win_wchstr\fP,
51 \fB\%win_wchnstr\fP,
52 \fB\%mvin_wchstr\fP,
53 \fB\%mvin_wchnstr\fP,
54 \fB\%mvwin_wchstr\fP,
55 \fB\%mvwin_wchnstr\fP \-
56 get a \fIcurses\fR complex character string from a window
57 .SH SYNOPSIS
58 .nf
59 \fB#include <curses.h>
60 .PP
61 \fBint in_wchstr(cchar_t *\fIwchstr\fP);
62 \fBint win_wchstr(WINDOW *\fIwin\fP, cchar_t *\fIwchstr\fP);
63 \fBint mvin_wchstr(int \fIy\fP, int \fIx\fP, cchar_t *\fIwchstr\fP);
64 \fBint mvwin_wchstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t *\fIwchstr\fP);
65 .PP
66 \fBint in_wchnstr(cchar_t *\fIwchstr\fP, int \fIn\fP);
67 \fBint win_wchnstr(WINDOW *\fIwin\fP, cchar_t *\fIwchstr\fP, int \fIn\fP);
68 \fBint mvin_wchnstr(int \fIy\fP, int \fIx\fP, cchar_t *\fIwchstr\fP, int \fIn\fP);
69 \fBint mvwin_wchnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t *\fIwchstr\fP, int \fIn\fP);
70 .fi
71 .SH DESCRIPTION
72 These functions return an array of complex characters in \fIwchstr\fP,
73 starting at the current cursor position in the named window.
74 Attributes (rendition) are stored with the characters.
75 .PP
76 The four functions with \fIn\fP as the last argument return
77 a leading substring at most \fIn\fP characters long
78 (exclusive of the trailing zeroed \fBcchar_t\fR.
79 Transfer stops at the end of the current line, or when \fIn\fP characters have
80 been stored at the location referenced by \fIwchstr\fP.
81 .PP
82 Constants defined in \fB<curses.h>\fP can be used with the \fB&\fP
83 (logical \*(``and\*('')
84 operator to extract the character or the attribute alone from any position
85 in the \fIwchstr\fP [see \fB\%getcchar\fP(3NCURSES)].
86 .SH RETURN VALUE
87 Upon successful completion, these functions return
88 \fBOK\fP.
89 Otherwise, they return
90 \fBERR\fP.
91 .PP
92 .I \%ncurses
93 returns
94 .B ERR
95 .bP
96 if the \fIwin\fP parameter is null or
97 .bP
98 if the \fIwchstr\fP parameter is null.
99 .PP
100 Functions prefixed with \*(``mv\*('' first perform cursor movement and
101 fail if the position
102 .RI ( y ,
103 .IR x )
104 is outside the window boundaries.
105 .SH NOTES
106 All of these functions except
107 .B \%win_wchnstr
108 may be implemented as macros.
109 .PP
110 Reading a line that overflows the array pointed to by
111 \fIwchstr\fP
112 with
113 \fBin_wchstr\fP,
114 \fBmvin_wchstr\fP,
115 \fBmvwin_wchstr\fP
116 or
117 \fBwin_wchstr\fP
118 causes undefined results.
119 Therefore, the use of
120 \fBin_wchnstr\fP,
121 \fBmvin_wchnstr\fP,
122 \fBmvwin_wchnstr\fP, or
123 \fBwin_wchnstr\fP
124 is recommended.
125 .SH PORTABILITY
126 X/Open Curses Issue\ 4 describes these functions.
127 It specifies no error conditions for them.
128 .SH HISTORY
129 X/Open Curses Issue\ 4 (1995) initially specified these functions.
130 The System\ V Interface Definition Version\ 4
131 of the same year
132 specified a function named
133 .I \%winwchstr
134 (and the usual variants).
135 .\" SVID 4, vol 3., p. 515
136 This was a later addition to
137 .RI SVr4. x ,
138 not appearing in the first SVr4 (1989).
139 It differed from X/Open's later
140 .I \%win_wchstr
141 in that it took an argument of type
142 .RI pointer-to- chtype
143 instead of
144 .RI pointer-to cchar_t .
145 .SH SEE ALSO
146 \fB\%inchstr\fP(3NCURSES) describes comparable functions of the
147 .I \%ncurses
148 library in its non-wide-character configuration.
149 .PP
150 \fB\%ncurses\fP(3NCURSES),
151 \fB\%inwstr\fP(3NCURSES),
152 \fB\%in_wch\fP(3NCURSES)