opensolaris man page for winch

inch(3XCURSES)						  X/Open Curses Library Functions					    inch(3XCURSES)

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

SYNOPSIS
       cc [ flag... ] file... -I /usr/xpg4/include  -L	/usr/xpg4/lib 
	-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)

SunOS 5.11							    5 Jun 2002							    inch(3XCURSES)