ncurses 6.4 - patch 20240420

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

diff --git a/man/curs_get_wstr.3x b/man/curs_get_wstr.3x
index 697dfd1c6c56b1448d4723f68889b11846c424d7..32ae541abaf91264b9c493a891c4b410e9b6e15a 100644 (file)
--- a/man/curs_get_wstr.3x
+++ b/man/curs_get_wstr.3x
@@ -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_get_wstr.3x,v 1.39 2023/11/11 11:39:29 tom Exp $
-.TH curs_get_wstr 3X 2023-11-11 "ncurses 6.4" "Library calls"
+.\" $Id: curs_get_wstr.3x,v 1.48 2024/04/20 19:18:18 tom Exp $
+.TH curs_get_wstr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
 .ie \n(.g \{\
 .ds `` \(lq
 .ds '' \(rq
@@ -130,6 +130,28 @@ versions read at most
 \fIn\fP
 characters, letting the application prevent overflow of the
 input buffer.
+.SH RETURN VALUE
+All of these functions return the integer \fBOK\fP upon successful completion.
+If unsuccessful, they return \fBERR\fP.
+.PP
+X/Open defines no error conditions.
+.PP
+In this implementation,
+these functions return an error
+.bP
+if the window pointer is null,
+.bP
+if its timeout expires without having any data, or
+.bP
+if the associated call to
+\fBwget_wch\fP
+failed.
+.PP
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 Any of these functions other than
 \fBwgetn_wstr\fP
@@ -154,27 +176,6 @@ respectively, is recommended.
 .PP
 These functions cannot return \fBKEY_\fP values because there
 is no way to distinguish a \fBKEY_\fP value from a valid \fBwchar_t\fP value.
-may be macros.
-.SH RETURN VALUE
-All of these functions return the integer \fBOK\fP upon successful completion.
-If unsuccessful, they return \fBERR\fP.
-.PP
-X/Open defines no error conditions.
-.PP
-In this implementation,
-these functions return an error
-.bP
-if the window pointer is null,
-.bP
-if its timeout expires without having any data, or
-.bP
-if the associated call to
-\fBwget_wch\fP
-failed.
-.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.
 .SH PORTABILITY
 These functions are described in The Single Unix Specification, Version 2.
 No error conditions are defined.
@@ -209,14 +210,17 @@ This implementation counts the terminator in the length.
 X/Open Curses does not specify what happens if the length \fIn\fP is negative.
 .bP
 For analogy with \fBwgetnstr\fP,
-ncurses 6.2 uses a limit (based on \fBLINE_MAX\fP).
+\fI\%ncurses\fP 6.2 uses a limit (based on \fBLINE_MAX\fP).
 .bP
 Some other implementations (such as Solaris xcurses) do the same,
 while others (PDCurses) do not allow this.
 .bP
-NetBSD 7 curses imitates ncurses 6.1 in this regard,
+NetBSD 7 curses imitates \fI\%ncurses\fP 6.1 in this regard,
 treating a \fB\-1\fP as an indefinite number of characters.
 .SH SEE ALSO
+\fB\%curs_getstr\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its non-wide-character configuration.
+.PP
 \fB\%curses\fP(3X),
-\fB\%curs_getstr\fP(3X),
 \fB\%curs_get_wch\fP(3X)