Debian Codegraph @

upstream/debian-unstable/man3/in_wch.3ncurses

raw
1 .\"***************************************************************************
2 .\" Copyright 2018-2024,2025 Thomas E. Dickey *
3 .\" Copyright 2002-2010,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_wch.3x,v 1.44 2025/02/01 22:54:32 tom Exp $
31 .TH in_wch 3NCURSES 2025-02-01 "ncurses 6.6" "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 .SH NAME
43 \fB\%in_wch\fP,
44 \fB\%win_wch\fP,
45 \fB\%mvin_wch\fP,
46 \fB\%mvwin_wch\fP \-
47 get a \fIcurses\fR complex character from a window
48 .SH SYNOPSIS
49 .nf
50 \fB#include <curses.h>
51 .PP
52 \fBint in_wch(cchar_t * \fIwch\fP);
53 \fBint win_wch(WINDOW * \fIwin\fP, cchar_t * \fIwch\fP);
54 \fBint mvin_wch(int \fIy\fP, int \fIx\fP, cchar_t * \fIwch\fP);
55 \fBint mvwin_wch(WINDOW * \fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t * \fIwch\fP);
56 .fi
57 .SH DESCRIPTION
58 .B \%win_wch
59 copies the
60 .I curses
61 complex character at the cursor position in
62 .I win
63 into
64 .IR wch "."
65 Use \fB\%getcchar\fP(3NCURSES) to extract its character code,
66 attributes,
67 and color pair identifier.
68 \fB\%ncurses\fP(3NCURSES) describes the variants of this function.
69 .SH RETURN VALUE
70 These functions return
71 .B OK
72 on success and
73 .B ERR
74 on failure.
75 .PP
76 In
77 .IR \%ncurses ","
78 they return
79 .B ERR
80 if
81 .I win
82 is
83 .IR NULL "."
84 .PP
85 Functions prefixed with \*(``mv\*('' first perform cursor movement and
86 fail if the position
87 .RI ( y ,
88 .IR x )
89 is outside the window boundaries.
90 .SH NOTES
91 .BR \%in_wch ","
92 .BR mvin_wch ","
93 and
94 .B mvwin_wch
95 may be implemented as macros.
96 .PP
97 Unlike \fB\%winch\fP(3NCURSES),
98 .B \%win_wch
99 and its variants store the value of the retrieved character in an
100 additional
101 .I wch
102 parameter instead of the return value.
103 .SH PORTABILITY
104 X/Open Curses Issue\ 4 describes these functions.
105 It specifies no error conditions for them.
106 .SH HISTORY
107 X/Open Curses Issue\ 4 (1995) initially specified these functions.
108 The System\ V Interface Definition Version\ 4
109 of the same year
110 specified a function named
111 .I \%winwch
112 (and the usual variants).
113 .\" SVID 4, vol 3., p. 514
114 This was a later addition to
115 .RI SVr4. x ,
116 not appearing in the first SVr4 (1989).
117 It differed from X/Open's later
118 .I \%win_wch
119 in that it returned a value of type
120 .I \%chtype
121 instead of
122 .IR \%cchar_t "."
123 .SH SEE ALSO
124 \fB\%inch\fP(3NCURSES) describes comparable functions of the
125 .I \%ncurses
126 library in its non-wide-character configuration.
127 .PP
128 \fB\%ncurses\fP(3NCURSES),
129 \fB\%inwstr\fP(3NCURSES)