X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_get_wstr.3x;h=be4dc371adea28d435e88bfd8ba7cedeb7669bf5;hp=8bfc467a02a98f6ad7896d73465396266c6792ec;hb=dcfe712cb3492636e8d50c9867cf05aec089a576;hpb=9bb12d03d854ce72b456e525f0c560f2fa91545d diff --git a/man/curs_get_wstr.3x b/man/curs_get_wstr.3x index 8bfc467a..be4dc371 100644 --- a/man/curs_get_wstr.3x +++ b/man/curs_get_wstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2006,2010 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_get_wstr.3x,v 1.7 2010/08/14 23:31:42 tom Exp $ +.\" $Id: curs_get_wstr.3x,v 1.11 2017/03/04 21:24:04 tom Exp $ .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_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\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. -.SH RETURN VALUES +.SH RETURN VALUE All of these functions return \fBOK\fR upon successful completion. Otherwise, they return \fBERR\fR. .PP @@ -167,16 +167,20 @@ In the latter case, an ERR return without other data is treated as an end-of-file condition, and the returned array contains a \fBWEOF\fR followed by a null \fBwchar_t\fR. .PP -X/Open curses documents these functions to pass an array of \fBwchar_t\fR, -but all of the vendors implement this using \fBwint_t\fR. +X/Open curses documented these functions to pass an array of \fBwchar_t\fR +in 1997, but that was an error because of this part of the description: +.RS +.PP +The effect of \fIget_wstr()\fP is as though a series of calls to +\fIget_wch()\fP were made, until a newline character, end-of-line character, or +end-of-file character is processed. +.RE +.PP +The latter function \fIget_wch()\fP can return a negative value, +while \fBwchar_t\fP is a unsigned type. +All of the vendors implement this using \fBwint_t\fR, following the standard. .SH SEE ALSO 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: