summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-tumbleweed/man3/in_wch.3ncurses
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-17 10:51:52 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-17 10:51:52 +0000
commit4ad94864781f48b1a4b77f9cfb934622bf756ba1 (patch)
tree3900955c1886e6d2570fea7125ee1f01bafe876d /upstream/opensuse-tumbleweed/man3/in_wch.3ncurses
parentAdding upstream version 4.22.0. (diff)
downloadmanpages-l10n-4ad94864781f48b1a4b77f9cfb934622bf756ba1.tar.xz
manpages-l10n-4ad94864781f48b1a4b77f9cfb934622bf756ba1.zip
Adding upstream version 4.23.0.upstream/4.23.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/opensuse-tumbleweed/man3/in_wch.3ncurses')
-rw-r--r--upstream/opensuse-tumbleweed/man3/in_wch.3ncurses35
1 files changed, 19 insertions, 16 deletions
diff --git a/upstream/opensuse-tumbleweed/man3/in_wch.3ncurses b/upstream/opensuse-tumbleweed/man3/in_wch.3ncurses
index dca37d8a..203f8d1b 100644
--- a/upstream/opensuse-tumbleweed/man3/in_wch.3ncurses
+++ b/upstream/opensuse-tumbleweed/man3/in_wch.3ncurses
@@ -1,5 +1,5 @@
.\"***************************************************************************
-.\" Copyright 2018-2022,2023 Thomas E. Dickey *
+.\" Copyright 2018-2023,2024 Thomas E. Dickey *
.\" Copyright 2002-2010,2017 Free Software Foundation, Inc. *
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
@@ -27,8 +27,8 @@
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_in_wch.3x,v 1.24 2023/11/18 18:00:11 tom Exp $
-.TH in_wch 3NCURSES 2023-11-18 "ncurses 6.4" "Library calls"
+.\" $Id: curs_in_wch.3x,v 1.31 2024/04/20 21:20:07 tom Exp $
+.TH in_wch 3NCURSES 2024-04-20 "ncurses 6.5" "Library calls"
.ie \n(.g \{\
.ds `` \(lq
.ds '' \(rq
@@ -49,33 +49,36 @@ get a \fIcurses\fR complex character from a window
.nf
\fB#include <ncursesw/curses.h>
.PP
-\fBint in_wch(cchar_t *\fIwcval\fP);
-\fBint win_wch(WINDOW *\fIwin\fP, cchar_t *\fIwcval\fP);
+\fBint in_wch(cchar_t *\fIwch\fP);
+\fBint win_wch(WINDOW *\fIwin\fP, cchar_t *\fIwch\fP);
.PP
-\fBint mvin_wch(int \fIy\fP, int \fIx\fP, cchar_t *\fIwcval\fP);
-\fBint mvwin_wch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t *\fIwcval\fP);
+\fBint mvin_wch(int \fIy\fP, int \fIx\fP, cchar_t *\fIwch\fP);
+\fBint mvwin_wch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t *\fIwch\fP);
.fi
.SH DESCRIPTION
These functions extract the complex character and rendition from
the current position in the named window into the \fBcchar_t\fP object
-referenced by wcval.
+referenced by wch.
.SH RETURN VALUE
-No errors are defined in the XSI Curses standard.
+No errors are defined in X/Open Curses.
This implementation checks for null pointers, returns \fBERR\fP in that case.
Also, the \fImv\fP routines check for error moving the cursor,
returning \fBERR\fP in that case.
Otherwise they return \fBOK\fP.
.PP
-Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
.SH NOTES
Note that all of these routines may be macros.
.SH PORTABILITY
-These functions are described in the XSI Curses standard, Issue 4.
+These functions are described in X/Open Curses, Issue 4.
.SH SEE ALSO
+\fB\%inch\fP(3NCURSES) describes comparable functions of the
+.I \%ncurses
+library in its non-wide-character configuration.
+.PP
\fB\%ncurses\fP(3NCURSES),
-\fB\%inch\fP(3NCURSES),
-\fB\%inchstr\fP(3NCURSES),
-\fB\%instr\fP(3NCURSES),
\fB\%inwstr\fP(3NCURSES)