ncurses 6.0 - patch 20170304
[ncurses.git] / man / curs_inwstr.3x
index b345ce6e6fd5fafd41a9d2aa2da56c4c86490780..0cdf4d8df65b6116b73882d0b093a9046d35242c 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 2002 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_inwstr.3x,v 1.2 2002/04/13 20:25:35 tom Exp $
-.TH curs_inwstr 3 ""
+.\" $Id: curs_inwstr.3x,v 1.8 2012/11/03 23:03:59 tom Exp $
+.TH curs_inwstr 3X ""
 .SH NAME
-.PP
 \fBinwstr\fR,
 \fBinnwstr\fR,
 \fBwinwstr\fR,
@@ -41,7 +40,7 @@
 .SH SYNOPSIS
 .nf
 \fB#include <curses.h> \fR
-
+.sp
 \fBint inwstr(\fR\fBwchar_t *\fR\fIstr\fR\fB);\fR
 .br
 \fBint innwstr(\fR\fBwchar_t *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR
@@ -73,7 +72,7 @@ an error is generated.
 Note that all routines except
 \fBwinnwstr\fR
 may be macros.
-.SH RETURN VALUES
+.SH RETURN VALUE
 All routines return
 \fBERR\fR
 upon failure. Upon
@@ -82,14 +81,11 @@ routines return
 \fBOK\fR, and the *\fBinnwstr\fR
 routines return the
 number of characters read into the string.
+.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 SEE ALSO
-Functions:
 \fBcurses\fR(3X),
 \fBcurs_instr\fR(3X),
 \fBcurs_in_wchstr\fR(3X)
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: