X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_in_wch.3x;h=a17135ec2d0440af183a47964dd566d0985c29b0;hp=8709d130f18032d7a8f623f1ae8eeb8e31b8daec;hb=84cf9f63bf604413fa5714ef91f83076ac8f236b;hpb=027ae42953e3186daed8f3882da73de48291b606 diff --git a/man/curs_in_wch.3x b/man/curs_in_wch.3x index 8709d130..a17135ec 100644 --- a/man/curs_in_wch.3x +++ b/man/curs_in_wch.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 2002,2006 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 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 +27,17 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_in_wch.3x,v 1.2 2006/02/25 21:42:22 tom Exp $ +.\" $Id: curs_in_wch.3x,v 1.9 2020/02/02 23:34:34 tom Exp $ .TH curs_in_wch 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .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 +54,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 -in that case. -Otherwise they return OK +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 \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 +69,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: