ncurses 6.1 - patch 20190216

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

diff --git a/man/curs_in_wchstr.3x b/man/curs_in_wchstr.3x
index 0012789f70fbda03f12bb88cc25a9de11c6dfe7e..fd0a0ea23a65b5589956384184e3a331da4047b3 100644 (file)
--- a/man/curs_in_wchstr.3x
+++ b/man/curs_in_wchstr.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 2002 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 2002-2017,2018 Free Software Foundation, Inc.              *

 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,8 +26,10 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_in_wchstr.3x,v 1.2 2002/05/18 21:48:30 tom Exp $
+.\" $Id: curs_in_wchstr.3x,v 1.11 2018/07/28 21:34:56 tom Exp $

 .TH curs_in_wchstr 3X ""
 .TH curs_in_wchstr 3X ""

+.na
+.hy 0

 .SH NAME
 \fBin_wchstr\fR,
 \fBin_wchnstr\fR,
 .SH NAME
 \fBin_wchstr\fR,
 \fBin_wchnstr\fR,


@@ -37,10 +39,12 @@
 \fBmvin_wchnstr\fR,
 \fBmvwin_wchstr\fR,
 \fBmvwin_wchnstr\fR \- get an array of complex characters and renditions from a curses window
 \fBmvin_wchnstr\fR,
 \fBmvwin_wchstr\fR,
 \fBmvwin_wchnstr\fR \- get an array of complex characters and renditions from a curses window

+.ad
+.hy

 .SH SYNOPSIS
 .nf
 \fB#include <curses.h>\fR
 .SH SYNOPSIS
 .nf
 \fB#include <curses.h>\fR

-
+.sp

 \fBint in_wchstr(cchar_t *\fR\fIwchstr\fR\fB);\fR
 .br
 \fBint in_wchnstr(cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR
 \fBint in_wchstr(cchar_t *\fR\fIwchstr\fR\fB);\fR
 .br
 \fBint in_wchnstr(cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR


@@ -88,30 +92,30 @@ with
 \fBmvwin_wchstr\fR
 or
 \fBwin_wchstr\fR
 \fBmvwin_wchstr\fR
 or
 \fBwin_wchstr\fR

-causes undefined results. Therefore, the use of
+causes undefined results.
+Therefore, the use of

 \fBin_wchnstr\fR,
 \fBmvin_wchnstr\fR,
 \fBmvwin_wchnstr\fR, or
 \fBwin_wchnstr\fR
 is recommended.
 \fBin_wchnstr\fR,
 \fBmvin_wchnstr\fR,
 \fBmvwin_wchnstr\fR, or
 \fBwin_wchnstr\fR
 is recommended.

-.SH RETURN VALUES
+.SH RETURN VALUE

 Upon successful completion, these functions return
 \fBOK\fR.
 Otherwise, they return
 \fBERR\fR.
 Upon successful completion, these functions return
 \fBOK\fR.
 Otherwise, they return
 \fBERR\fR.

+.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
 The XSI Curses defines no error conditions.
 This implementation checks for null pointers,
 .SH PORTABILITY
 The XSI Curses defines no error conditions.
 This implementation checks for null pointers,

-returning ERR in that case.
+returning \fBERR\fP in that case.

 .SH SEE ALSO
 Functions:
 \fBcurses\fR(3X),
 .SH SEE ALSO
 Functions:
 \fBcurses\fR(3X),

-\fBcurs_in_wch\fR(3X)
+\fBcurs_in_wch\fR(3X),

 \fBcurs_instr\fR(3X),
 \fBcurs_inwstr\fR(3X)
 \fBcurs_instr\fR(3X),
 \fBcurs_inwstr\fR(3X)

-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End:
+\fBcurs_inchstr\fR(3X)