X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_in_wch.3x;h=948d388e17e10277f22953e1b99b3647c3c1d844;hp=8709d130f18032d7a8f623f1ae8eeb8e31b8daec;hb=8d3ea9021573747ecd129228ba7782a03243f62c;hpb=027ae42953e3186daed8f3882da73de48291b606 diff --git a/man/curs_in_wch.3x b/man/curs_in_wch.3x index 8709d130..948d388e 100644 --- a/man/curs_in_wch.3x +++ b/man/curs_in_wch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2010,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,13 +26,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_in_wch.3x,v 1.2 2006/02/25 21:42:22 tom Exp $ +.\" $Id: curs_in_wch.3x,v 1.6 2017/11/21 00:53:44 tom Exp $ .TH curs_in_wch 3X "" .SH NAME \fBin_wch\fR, \fBmvin_wch\fR, \fBmvwin_wch\fR, -\fBwin_wch\fR - extract a complex character and rendition from a window +\fBwin_wch\fR \- extract a complex character and rendition from a window .SH SYNOPSIS \fB#include \fR .sp @@ -49,10 +49,14 @@ the current position in the named window into the \fBcchar_t\fR object referenced by wcval. .SH RETURN VALUE No errors are defined in the XSI Curses standard. -This implementation checks for null pointers, returns ERR in that case. -Also, the \fImv\fR routines check for error moving the cursor, returning ERR +This implementation checks for null pointers, returns \fBERR\fP in that case. +Also, the \fImv\fR routines check for error moving the cursor, returning \fBERR\fP in that case. -Otherwise they return OK +Otherwise they return \fBOK\fP. +.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 NOTES Note that all of these routines may be macros. .SH PORTABILITY @@ -60,9 +64,3 @@ These functions are described in the XSI Curses standard, Issue 4. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_inch\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: