Sun Microsystems, Inc.
spacerspacer
spacer   www.sun.com docs.sun.com | | |  
spacer
black dot
   
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   V   W   X   Y   Z
    
 
X/Open Curses Library Functionsinch(3XCURSES)


NAME

 inch, mvinch, mvwinch, winch - return a single-byte character (with rendition)

SYNOPSIS

 
#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.

SEE ALSO

 

addch(3XCURSES), attroff(3XCURSES)


SunOS 5.9Go To TopLast Changed 1 Jun 1996

 
      
      
Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.