69 lines
3.4 KiB
Plaintext
69 lines
3.4 KiB
Plaintext
.\"***************************************************************************
|
|
.\" Copyright (c) 2002 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 *
|
|
.\" "Software"), to deal in the Software without restriction, including *
|
|
.\" without limitation the rights to use, copy, modify, merge, publish, *
|
|
.\" distribute, distribute with modifications, sublicense, and/or sell *
|
|
.\" copies of the Software, and to permit persons to whom the Software is *
|
|
.\" furnished to do so, subject to the following conditions: *
|
|
.\" *
|
|
.\" The above copyright notice and this permission notice shall be included *
|
|
.\" in all copies or substantial portions of the Software. *
|
|
.\" *
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
.\" *
|
|
.\" Except as contained in this notice, the name(s) of the above copyright *
|
|
.\" holders shall not be used in advertising or otherwise to promote the *
|
|
.\" sale, use or other dealings in this Software without prior written *
|
|
.\" authorization. *
|
|
.\"***************************************************************************
|
|
.\"
|
|
.\" $Id: curs_in_wch.3x,v 1.1 2002/03/10 15:08:57 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
|
|
.SH SYNOPSIS
|
|
\fB#include <curses.h>\fR
|
|
|
|
\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
|
|
.br
|
|
\fBint mvwin_wch(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwcval\fR\fB);\fR
|
|
.br
|
|
\fBint win_wch(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwcval\fR\fB);\fR
|
|
.SH DESCRIPTION
|
|
These functions extract the complex character and rendition from
|
|
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
|
|
.SH NOTES
|
|
Note that all of these routines may be macros.
|
|
.SH PORTABILITY
|
|
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:
|