xref: /titanic_44/usr/src/man/man3xcurses/inch.3xcurses (revision ed22c7109fc5dd9e1b7a5d0333bdc7ad2718e2ab)
te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved 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]
INCH 3XCURSES "Jun 5, 2002"
NAME
inch, mvinch, mvwinch, winch - return a single-byte character (with rendition)
SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \e
 -R  /usr/xpg4/lib  -lcurses  [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

chtype inch(void);

chtype mvinch(int y, int x);

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

chtype winch(WINDOW *win);
DESCRIPTION

The inch() and winch() functions return the chtype character located at the current cursor position of the stdscr window and window win, respectively. The mvinch() and mvwinch() functions return the chtype character located at the position indicated by the x (column) and y (row) parameters (the former in the stdscr window; the latter in window win).

The complete character/attribute pair will be returned. The character or attributes can be extracted by performing a bitwise AND on the returned value, using the constants A_CHARTEXT, A_ATTRIBUTES, and A_COLOR.

PARAMETERS
y

Is the y (row) coordinate of the position of the character to be returned.

x

Is the x (column) coordinate of the position of the character to be returned.

win

Is a pointer to the window that contains the character to be returned.

RETURN VALUES

On success, these functions return the specified character and rendition. Otherwise, they return ERR.

ERRORS

None.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level Unsafe
SEE ALSO

addch(3XCURSES), attroff(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5)