X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_get_wstr.3x;h=2a3fb3ce27bf19ce5f634f6324eca2f46b35aa9b;hp=4286c78b0d2ace95f97022e23d1ad161613e4eb7;hb=a1e63be290fce9e589bc57c9f753be09e8ac0cc7;hpb=027ae42953e3186daed8f3882da73de48291b606 diff --git a/man/curs_get_wstr.3x b/man/curs_get_wstr.3x index 4286c78b..2a3fb3ce 100644 --- 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-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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_get_wstr.3x,v 1.6 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_get_wstr.3x,v 1.9 2012/11/03 23:03:59 tom Exp $ .TH curs_get_wstr 3X "" .na .hy 0 @@ -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 @@ -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 +.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. @@ -170,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: