* Recast "DESCRIPTION" section. * Recast presentation of ncurses-specific failure modes. * Fix missing hyphen in "HISTORY" section. * Favor man(7) font style macros over *roff font selection escape sequences, except for man page cross references (because man/make_sed.sh recognizes only certain patterns when rewriting such cross references) and terms in the "NAME" section (because the generated edit_man.sh script expects font selection escape sequences when scraping terms thence to gather names for man page aliases). * Quote (single-character) trailing punctuation arguments to man(7) font alternation macros. The package does not require this; it avoids false positives reported by one of Thomas Dickey's style-checking scripts, per his communication. --- man/curs_in_wchstr.3x | 63 +++++++++++++++++++++++++++++-------------- 1 file changed, 43 insertions(+), 20 deletions(-)
diff --git a/man/curs_in_wchstr.3x b/man/curs_in_wchstr.3x
index 48fa95956..c42ac7a73 100644
--- a/man/curs_in_wchstr.3x
+++ b/man/curs_in_wchstr.3x
@@ -71,20 +71,33 @@ .SH SYNOPSIS
cchar_t * \fIwchstr\fP, int \fIn\fP)
.fi
.SH DESCRIPTION
-These functions return an array of complex characters in \fIwchstr\fP,
-starting at the current cursor position in the named window.
-Attributes (rendition) are stored with the characters.
-.PP
-The four functions with \fIn\fP as the last argument return
-a leading substring at most \fIn\fP characters long
-(exclusive of the trailing zeroed \fBcchar_t\fR.
-Transfer stops at the end of the current line, or when \fIn\fP characters have
-been stored at the location referenced by \fIwchstr\fP.
-.PP
-Constants defined in \fB<curses.h>\fP can be used with the \fB&\fP
-(logical \*(``and\*('')
-operator to extract the character or the attribute alone from any position
-in the \fIwchstr\fP [see \fBgetcchar\fP(3X)].
+.B \%win_wchstr
+extracts a
+.I curses
+complex character string from a
+.I curses
+window
+.IR win ","
+starting at the cursor and stopping at the end of the line,
+and stores it in
+.IR wchstr ","
+terminating it with a wide null
+.I curses
+character.
+.B \%win_wchnstr
+does the same,
+but copies at most
+.I n
+.I curses
+complex characters from
+.IR win "."
+A negative
+.I n
+implies no limit;
+.B \%win_wchnstr
+then works like
+.BR \%win_wchstr "."
+\fB\%ncurses\fP(3X) describes the variants of these functions.
.SH RETURN VALUE
These functions return
.B OK
@@ -92,13 +105,23 @@ .SH RETURN VALUE
.B ERR
on failure.
.PP
-.I \%ncurses
-returns
-.B ERR
+In
+.IR \%ncurses ","
+these functions fail if
.bP
-if the \fIwin\fP parameter is null or
+the
+.I curses
+screen has not been initialized,
.bP
-if the \fIwchstr\fP parameter is null.
+(for functions taking a
+.I \%WINDOW
+pointer argument)
+.I win
+is a null pointer,
+or
+.bP
+.I wchstr
+is a null pointer.
.PP
Functions prefixed with \*(``mv\*('' first perform cursor movement and
fail if the position
@@ -139,7 +162,7 @@ .SH HISTORY
in that it took an argument of type
.RI pointer-to- chtype
instead of
-.RI pointer-to cchar_t .
+.RI pointer-to- cchar_t "."
.SH SEE ALSO
\fB\%curs_inchstr\fP(3X) describes comparable functions of the
.I \%ncurses
--
2.30.2
signature.asc
Description: PGP signature
