X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_in_wchstr.3x;h=dda9f2487311edb9eb06d74a7278821fc46bc30c;hp=b04a1f54cd7667fa669bbe6ad9709466e1ee39cf;hb=96a4663880a73a00b11700da8a404fdd56833925;hpb=027ae42953e3186daed8f3882da73de48291b606 diff --git a/man/curs_in_wchstr.3x b/man/curs_in_wchstr.3x index b04a1f54..dda9f248 100644 --- a/man/curs_in_wchstr.3x +++ b/man/curs_in_wchstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2018,2019 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,12 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_in_wchstr.3x,v 1.6 2006/12/02 17:03:07 tom Exp $ +.\" $Id: curs_in_wchstr.3x,v 1.12 2019/11/30 21:06:30 tom Exp $ .TH curs_in_wchstr 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .na .hy 0 .SH NAME @@ -92,21 +96,26 @@ with \fBmvwin_wchstr\fR or \fBwin_wchstr\fR -causes undefined results. Therefore, the use of +causes undefined results. +Therefore, the use of \fBin_wchnstr\fR, \fBmvin_wchnstr\fR, \fBmvwin_wchnstr\fR, or \fBwin_wchnstr\fR is recommended. -.SH RETURN VALUES +.SH RETURN VALUE Upon successful completion, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.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 The XSI Curses defines no error conditions. This implementation checks for null pointers, -returning ERR in that case. +returning \fBERR\fP in that case. .SH SEE ALSO Functions: \fBcurses\fR(3X), @@ -114,9 +123,3 @@ Functions: \fBcurs_instr\fR(3X), \fBcurs_inwstr\fR(3X) \fBcurs_inchstr\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: