X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_get_wstr.3x;h=22f0e0685af923b5b93a44390545a933bd0c0a18;hp=86a5b82a11fc869af7f1b9360306d0a5afe3b72d;hb=dc690a36a0e53e2c2ecd99c971cd749f78275fdc;hpb=a8987e73ec254703634802b4f7ee30d3a485524d

diff --git a/man/curs_get_wstr.3x b/man/curs_get_wstr.3x
index 86a5b82a..22f0e068 100644
--- a/man/curs_get_wstr.3x
+++ b/man/curs_get_wstr.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 2002,2003 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,8 +26,10 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_get_wstr.3x,v 1.3 2003/07/05 11:15:28 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
 .SH NAME
 \fBget_wstr\fR,
 \fBgetn_wstr\fR,
@@ -37,10 +39,12 @@
 \fBmvgetn_wstr\fR,
 \fBmvwget_wstr\fR,
 \fBmvwgetn_wstr\fR \- get an array of wide characters from a curses terminal keyboard
+.ad
+.hy
 .SH SYNOPSIS
 .nf
 \fB#include <curses.h>\fR
-
+.sp
 \fBint get_wstr(wint_t *\fR\fIwstr\fR\fB);\fR
 .br
 \fBint getn_wstr(wint_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR
@@ -62,28 +66,28 @@ The effect of
 \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.
 In all instances, the end of the string is terminated by a null \fBwchar_t\fR.
 The routine places resulting values in the area pointed to by \fIwstr\fR.
-
+.PP
 The user's erase and kill characters are interpreted.  If keypad
 mode is on for the window, \fBKEY_LEFT\fR and \fBKEY_BACKSPACE\fR
 are both considered equivalent to the user's kill character.
-
+.PP
 Characters input are echoed only if \fBecho\fR is currently on.  In that case,
 backspace is echoed as deletion of the previous character (typically a left
 motion).
-
+.PP
 The effect of
 \fBwget_wstr\fR
 is as though a series of
 calls to
 \fBwget_wch\fR
 were made.
-
+.PP
 The effect of
 \fBmvget_wstr\fR
 is as though a call to
@@ -92,7 +96,7 @@ and then a series of calls to
 \fBget_wch\fR
 were
 made.
-
+.PP
 The effect of
 \fBmvwget_wstr\fR
 is as though a call to
@@ -100,7 +104,7 @@ is as though a call to
 and then a series of calls to
 \fBwget_wch\fR
 were made.
-
+.PP
 The
 \fBgetn_wstr\fR,
 \fBmvgetn_wstr\fR,
@@ -135,14 +139,25 @@ The use of
 \fBmvgetn_wstr\fR,
 \fBmvwgetn_wstr\fR, or
 \fBwgetn_wstr\fR, respectively, is recommended.
-
+.PP
 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.
-.SH RETURN VALUES
+.SH RETURN VALUE
 All of these functions return \fBOK\fR upon successful completion.
 Otherwise, they return \fBERR\fR.
+.PP
+Functions using a window parameter return an error if it is null.
+.RS
+.TP 5
+\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.
@@ -159,9 +174,3 @@ Functions:
 \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: