ncurses 6.2 - patch 20201212
[ncurses.git] / man / curs_in_wch.3x
1 .\"***************************************************************************
2 .\" Copyright 2018-2019,2020 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.10 2020/10/17 23:19:29 tom Exp $
31 .TH curs_in_wch 3X ""
32 .ie \n(.g .ds `` \(lq
33 .el       .ds `` ``
34 .ie \n(.g .ds '' \(rq
35 .el       .ds '' ''
36 .SH NAME
37 \fBin_wch\fR,
38 \fBmvin_wch\fR,
39 \fBmvwin_wch\fR,
40 \fBwin_wch\fR \- extract a complex character and rendition from a window
41 .SH SYNOPSIS
42 \fB#include <curses.h>\fR
43 .sp
44 \fBint in_wch(cchar_t *\fR\fIwcval\fR\fB);\fR
45 .br
46 \fBint win_wch(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwcval\fR\fB);\fR
47 .sp
48 \fBint mvin_wch(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwcval\fR\fB);\fR
49 .br
50 \fBint mvwin_wch(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwcval\fR\fB);\fR
51 .SH DESCRIPTION
52 These functions extract the complex character and rendition from
53 the current position in the named window into the \fBcchar_t\fR object
54 referenced by wcval.
55 .SH RETURN VALUE
56 No errors are defined in the XSI Curses standard.
57 This implementation checks for null pointers, returns \fBERR\fP in that case.
58 Also, the \fImv\fR routines check for error moving the cursor,
59 returning \fBERR\fP in that case.
60 Otherwise they return \fBOK\fP.
61 .PP
62 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
63 \fBwmove\fP, and return an error if the position is outside the window,
64 or if the window pointer is null.
65 .SH NOTES
66 Note that all of these routines may be macros.
67 .SH PORTABILITY
68 These functions are described in the XSI Curses standard, Issue 4.
69 .SH SEE ALSO
70 \fBcurses\fR(3X),
71 \fBcurs_inch\fR(3X).