ncurses 6.5 - patch 20240525

[ncurses.git] / man / curs_in_wchstr.3x

diff --git a/man/curs_in_wchstr.3x b/man/curs_in_wchstr.3x
index fa012b21d25893e103ea409d534359c9deb6f6d7..0b821c94a51fee500fe282cb80539002719fb5ec 100644 (file)
--- a/man/curs_in_wchstr.3x
+++ b/man/curs_in_wchstr.3x
@@ -27,8 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_in_wchstr.3x,v 1.34 2024/03/16 15:35:01 tom Exp $
-.TH curs_in_wchstr 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
+.\" $Id: curs_in_wchstr.3x,v 1.41 2024/05/25 20:10:58 tom Exp $
+.TH curs_in_wchstr 3X 2024-05-25 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"

 .ie \n(.g \{\
 .ds `` \(lq
 .ds '' \(rq
 .ie \n(.g \{\
 .ds `` \(lq
 .ds '' \(rq


@@ -59,13 +59,13 @@ get a \fIcurses\fR complex character string from a window
 \fB#include <curses.h>
 .PP
 \fBint in_wchstr(cchar_t *\fIwchstr\fP);
 \fB#include <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_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_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);
 \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
 \fBint mvwin_wchnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t *\fIwchstr\fP, int \fIn\fP);
 .fi
 .SH DESCRIPTION


@@ -89,15 +89,18 @@ Otherwise, they return
 \fBERR\fP.
 .PP
 X/Open Curses defines no error conditions.
 \fBERR\fP.
 .PP
 X/Open Curses defines no error conditions.

-This implementation returns an error
+This implementation returns
+.B ERR

 .bP
 if the \fIwin\fP parameter is null or
 .bP
 if the \fIwchstr\fP parameter is null.
 .PP
 .bP
 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
 .SH NOTES
 All routines except \fBwin_wchnstr\fP may be macros.
 .PP


@@ -117,12 +120,14 @@ Therefore, the use of
 \fBwin_wchnstr\fP
 is recommended.
 .SH PORTABILITY
 \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
 This implementation checks for null pointers,
 returning \fBERR\fP in that case.
 .SH SEE ALSO

+\fB\%curs_inchstr\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its non-wide-character configuration.
+.PP

 \fB\%curses\fP(3X),
 \fB\%curses\fP(3X),

-\fB\%curs_inchstr\fP(3X),
-\fB\%curs_instr\fP(3X),

 \fB\%curs_inwstr\fP(3X),
 \fB\%curs_in_wch\fP(3X)
 \fB\%curs_inwstr\fP(3X),
 \fB\%curs_in_wch\fP(3X)