xref: /illumos-gate/usr/src/man/man3curses/curs_inch.3curses (revision 689b9301078f0c35c7f198fcee8032a0d30eff3a)
te
Copyright 1989 AT&T
Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
CURS_INCH 3CURSES "Dec 31, 1996"
NAME
curs_inch, inch, winch, mvinch, mvwinch - get a character and its attributes from a curses window
SYNOPSIS

cc [ flag ... ] file ... -lcurses [ library ... ]
#include <curses.h>

chtype inch(void);

chtype winch(WINDOW *win);

chtype mvinch(int y, int x);

chtype mvwinch(WINDOW *win, int y, int x);
DESCRIPTION

With these routines, the character, of type chtype, at the current position in the named window is returned. If any attributes are set for that position, their values are OR-ed into the value returned. Constants defined in <curses.h> can be used with the logical AND (&) operator to extract the character or attributes alone.

"Attributes"

The following bit-masks can be AND-ed with characters returned by winch(). A_CHARTEXT

Bit-mask to extract character

A_ATTRIBUTES

Bit-mask to extract attributes

A_COLOR

Bit-mask to extract color-pair field information

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Unsafe
SEE ALSO

curses (3CURSES), attributes (7)

NOTES

The header <curses.h> automatically includes the headers <stdio.h> and <unctrl.h>.

Note that all of these routines may be macros.