ncurses 6.0 - patch 20171125
[ncurses.git] / man / curs_in_wchstr.3x
index b04a1f54cd7667fa669bbe6ad9709466e1ee39cf..f746d704b3691d28626720e8a708164e55bbb8a7 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 2002-2005,2006 Free Software Foundation, Inc.              *
+.\" Copyright (c) 2002-2012,2017 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            *
@@ -26,7 +26,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_in_wchstr.3x,v 1.6 2006/12/02 17:03:07 tom Exp $
+.\" $Id: curs_in_wchstr.3x,v 1.10 2017/11/21 00:53:44 tom Exp $
 .TH curs_in_wchstr 3X ""
 .na
 .hy 0
@@ -98,15 +98,19 @@ causes undefined results. Therefore, the use of
 \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.
+.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,
-returning ERR in that case.
+returning \fBERR\fP in that case.
 .SH SEE ALSO
 Functions:
 \fBcurses\fR(3X),
@@ -114,9 +118,3 @@ Functions:
 \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: