ncurses 6.0 - patch 20170121

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

diff --git a/man/curs_get_wstr.3x b/man/curs_get_wstr.3x
index 4286c78b0d2ace95f97022e23d1ad161613e4eb7..22f0e0685af923b5b93a44390545a933bd0c0a18 100644 (file)
--- a/man/curs_get_wstr.3x
+++ b/man/curs_get_wstr.3x
@@ -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            *
 .\"                                                                          *
 .\" 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_get_wstr.3x,v 1.6 2006/02/25 21:49:19 tom Exp $
+.\" $Id: curs_get_wstr.3x,v 1.10 2017/01/07 19:25:15 tom Exp $

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


@@ -66,7 +66,7 @@ The effect of
 \fBget_wstr\fR
 is as though a series of calls
 to
 \fBget_wstr\fR
 is as though a series of calls
 to

-\fBget_wch\fR
+\fBget_wch\fR(3X)

 were made, until a newline, other end-of-line, or end-of-file condition is processed.
 An end-of-file condition is represented by \fBWEOF\fR, as defined in \fB<wchar.h>\fR.
 The newline and end-of-line conditions are represented by the \fB\\n\fR \fBwchar_t\fR value.
 were made, until a newline, other end-of-line, or end-of-file condition is processed.
 An end-of-file condition is represented by \fBWEOF\fR, as defined in \fB<wchar.h>\fR.
 The newline and end-of-line conditions are represented by the \fB\\n\fR \fBwchar_t\fR value.


@@ -144,7 +144,7 @@ These functions cannot return \fBKEY_\fR values because there
 is no way to distinguish a \fBKEY_\fR value from a valid \fBwchar_t\fR value.
 .PP
 All of these routines except \fBwgetn_wstr\fR may be macros.
 is no way to distinguish a \fBKEY_\fR value from a valid \fBwchar_t\fR value.
 .PP
 All of these routines except \fBwgetn_wstr\fR may be macros.

-.SH RETURN VALUES
+.SH RETURN VALUE

 All of these functions return \fBOK\fR upon successful completion.
 Otherwise, they return \fBERR\fR.
 .PP
 All of these functions return \fBOK\fR upon successful completion.
 Otherwise, they return \fBERR\fR.
 .PP


@@ -154,6 +154,10 @@ Functions using a window parameter return an error if it is null.
 \fBwgetn_wstr\fP
 returns an error if the associated call to \fBwget_wch\fP failed.
 .RE
 \fBwgetn_wstr\fP
 returns an error if the associated call to \fBwget_wch\fP failed.
 .RE

+.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
 These functions are described in The Single Unix Specification, Version 2.
 No error conditions are defined.
 .SH PORTABILITY
 These functions are described in The Single Unix Specification, Version 2.
 No error conditions are defined.


@@ -170,9 +174,3 @@ Functions:
 \fBcurses\fR(3X),
 \fBcurs_get_wch\fR(3X),
 \fBcurs_getstr\fR(3X).
 \fBcurses\fR(3X),
 \fBcurs_get_wch\fR(3X),
 \fBcurs_getstr\fR(3X).

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