ncurses 6.5 - patch 20240608

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

diff --git a/man/curs_ins_wstr.3x b/man/curs_ins_wstr.3x
index f059fceec61c533e39bf2dc603348eb5a88b0703..37a583027f2786bc9c35a881ed5c30a5ccb49599 100644 (file)
--- a/man/curs_ins_wstr.3x
+++ b/man/curs_ins_wstr.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2019-2022,2023 Thomas E. Dickey                                *
+.\" Copyright 2019-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_ins_wstr.3x,v 1.29 2023/11/25 11:29:34 tom Exp $
-.TH curs_ins_wstr 3X 2023-11-25 "ncurses 6.4" "Library calls"
+.\" $Id: curs_ins_wstr.3x,v 1.42 2024/06/08 21:04:04 tom Exp $
+.TH curs_ins_wstr 3X 2024-06-08 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
 .ie \n(.g \{\
 .ds `` \(lq
 .ds '' \(rq
@@ -87,37 +87,68 @@ If \fIn\fP is less than zero, the entire string is inserted
 .PP
 Special characters are handled as in \fBwadd_wch\fP(3X).
 .SH RETURN VALUE
-All functions return the integer \fBERR\fP upon failure and \fBOK\fP on success.
+These functions return
+.B OK
+on success and
+.B ERR
+on failure.
 .PP
-X/Open does not define any error conditions.
-This implementation returns an error
+X/Open Curses does not specify any error conditions.
+In
+.IR \%ncurses ","
+they return
+.B ERR
+if
 .bP
-if the \fIwin\fP parameter is null or
+.I win
+is
+.BR NULL ","
 .bP
-if the \fIwstr\fP parameter is null or
+.I wstr
+is
+.BR NULL ","
+or
 .bP
-if the \fBwins_wch\fP function returns an error.
+an internal \fB\%wins_wch\fP(3X) call returns
+.BR ERR "."
 .PP
-Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP(3X), 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 but \fBwins_nwstr\fP may be macros.
+All of these functions except
+.B \%wins_nwstr
+may be implemented as macros.
 .PP
-If the first character in the string is a nonspacing character, these
-functions will fail.
-XSI does not define what will happen if a nonspacing character follows
-a control character.
+If the first character in the string is a non-spacing character,
+these functions return
+.BR ERR "."
+X/Open Curses does not specify what happens
+if a non-spacing character follows a control character.
 .SH PORTABILITY
-These functions are described in the XSI Curses standard, Issue 4,
-which adds \fI\%const\fP qualifiers to the arguments.
+X/Open Curses,
+Issue 4 describes these functions.
+It specifies no error conditions for them.
 .PP
-X/Open states that the entire string is inserted if \fIn\fP is less than 1.
+Issue 4 states that the entire string is inserted if
+.I n
+is less than 1.
 This is probably an error,
 because it is inconsistent with other functions,
-and differs from the X/Open implementation on Solaris.
+and differs from the SVr4
+.I curses
+and Solaris
+.I xcurses
+implementations.
+Nevertheless,
+Issue 7 retains it.
 .SH SEE ALSO
+\fB\%curs_insstr\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its non-wide-character configuration.
+.PP
 \fB\%curses\fP(3X),
-\fB\%curs_insstr\fP(3X),
 \fB\%curs_ins_wch\fP(3X),
 \fB\%curs_in_wch\fP(3X)