summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-tumbleweed/man3/in_wchstr.3ncurses
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/opensuse-tumbleweed/man3/in_wchstr.3ncurses')
-rw-r--r--upstream/opensuse-tumbleweed/man3/in_wchstr.3ncurses30
1 files changed, 17 insertions, 13 deletions
diff --git a/upstream/opensuse-tumbleweed/man3/in_wchstr.3ncurses b/upstream/opensuse-tumbleweed/man3/in_wchstr.3ncurses
index 6d8a0c57..1b7227b0 100644
--- a/upstream/opensuse-tumbleweed/man3/in_wchstr.3ncurses
+++ b/upstream/opensuse-tumbleweed/man3/in_wchstr.3ncurses
@@ -1,5 +1,5 @@
.\"***************************************************************************
-.\" Copyright 2018-2022,2023 Thomas E. Dickey *
+.\" Copyright 2018-2023,2024 Thomas E. Dickey *
.\" Copyright 2002-2012,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_wchstr.3x,v 1.32 2023/11/18 20:55:18 tom Exp $
-.TH in_wchstr 3NCURSES 2023-11-18 "ncurses 6.4" "Library calls"
+.\" $Id: curs_in_wchstr.3x,v 1.39 2024/04/20 21:24:19 tom Exp $
+.TH in_wchstr 3NCURSES 2024-04-20 "ncurses 6.5" "Library calls"
.ie \n(.g \{\
.ds `` \(lq
.ds '' \(rq
@@ -59,13 +59,13 @@ get a \fIcurses\fR complex character string from a window
\fB#include <ncursesw/curses.h>
.PP
\fBint in_wchstr(cchar_t *\fIwchstr\fP);
-\fBint in_wchnstr(cchar_t *\fIwchstr\fP, int \fIn\fP);
\fBint win_wchstr(WINDOW *\fIwin\fP, cchar_t *\fIwchstr\fP);
-\fBint win_wchnstr(WINDOW *\fIwin\fP, cchar_t *\fIwchstr\fP, int \fIn\fP);
-.PP
\fBint mvin_wchstr(int \fIy\fP, int \fIx\fP, cchar_t *\fIwchstr\fP);
-\fBint mvin_wchnstr(int \fIy\fP, int \fIx\fP, cchar_t *\fIwchstr\fP, int \fIn\fP);
\fBint mvwin_wchstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t *\fIwchstr\fP);
+.PP
+\fBint in_wchnstr(cchar_t *\fIwchstr\fP, int \fIn\fP);
+\fBint win_wchnstr(WINDOW *\fIwin\fP, cchar_t *\fIwchstr\fP, int \fIn\fP);
+\fBint mvin_wchnstr(int \fIy\fP, int \fIx\fP, cchar_t *\fIwchstr\fP, int \fIn\fP);
\fBint mvwin_wchnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t *\fIwchstr\fP, int \fIn\fP);
.fi
.SH DESCRIPTION
@@ -95,9 +95,11 @@ if the \fIwin\fP parameter is null or
.bP
if the \fIwchstr\fP parameter is null.
.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
All routines except \fBwin_wchnstr\fP may be macros.
.PP
@@ -117,12 +119,14 @@ Therefore, the use of
\fBwin_wchnstr\fP
is recommended.
.SH PORTABILITY
-The XSI Curses defines no error conditions.
+X/Open Curses defines no error conditions.
This implementation checks for null pointers,
returning \fBERR\fP in that case.
.SH SEE ALSO
+\fB\%inchstr\fP(3NCURSES) describes comparable functions of the
+.I \%ncurses
+library in its non-wide-character configuration.
+.PP
\fB\%ncurses\fP(3NCURSES),
-\fB\%inchstr\fP(3NCURSES),
-\fB\%instr\fP(3NCURSES),
\fB\%inwstr\fP(3NCURSES),
\fB\%in_wch\fP(3NCURSES)