X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_in_wch.3x;h=169ddf47078cc5f9dae9cee8c0f40d4a8bf44013;hp=668595c6f3ed2bd2f75447229b924183ed3f656d;hb=321b81e6b3fa425daddac02420d862100dc3aac8;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/man/curs_in_wch.3x b/man/curs_in_wch.3x index 668595c6..169ddf47 100644 --- a/man/curs_in_wch.3x +++ b/man/curs_in_wch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2017,2018 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,16 +26,16 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_in_wch.3x,v 1.1 2002/03/10 15:08:57 tom Exp $ +.\" $Id: curs_in_wch.3x,v 1.7 2018/07/28 22:20:54 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 \fBint in_wch(cchar_t *\fR\fIwcval\fR\fB);\fR .br \fBint mvin_wch(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwcval\fR\fB);\fR @@ -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 -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 +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: