ncurses 6.0 - patch 20170527

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

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

-.\" Copyright (c) 2002-2005,2006 Free Software Foundation, Inc.              *
+.\" Copyright (c) 2002-2010,2012 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,7 +26,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_in_wchstr.3x,v 1.6 2006/12/02 17:03:07 tom Exp $
+.\" $Id: curs_in_wchstr.3x,v 1.9 2012/11/03 23:03:59 tom Exp $

 .TH curs_in_wchstr 3X ""
 .na
 .hy 0
 .TH curs_in_wchstr 3X ""
 .na
 .hy 0


@@ -98,11 +98,15 @@ causes undefined results. Therefore, the use of
 \fBmvwin_wchnstr\fR, or
 \fBwin_wchnstr\fR
 is recommended.
 \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,


@@ -114,9 +118,3 @@ Functions:
 \fBcurs_instr\fR(3X),
 \fBcurs_inwstr\fR(3X)
 \fBcurs_inchstr\fR(3X)
 \fBcurs_instr\fR(3X),
 \fBcurs_inwstr\fR(3X)
 \fBcurs_inchstr\fR(3X)

-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: