NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | PORTABILITY | SEE ALSO | COLOPHON

curs_inch(3X)                                                  curs_inch(3X)

NAME         top

       inch,  winch, mvinch, mvwinch - get a character and attributes from a
       curses window

SYNOPSIS         top

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

       These routines return the character, of type chtype, at the current
       position in the named window.  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 may 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

RETURN VALUE         top

       Functions with a "mv" prefix first perform a cursor movement using
       wmove, and return an error if the position is outside the window, or
       if the window pointer is null.

NOTES         top

       Note that all of these routines may be macros.

PORTABILITY         top

       These functions are described in the XSI Curses standard, Issue 4.

SEE ALSO         top

       curses(3X).

       Comparable functions in the wide-character (ncursesw) library are
       described in curs_in_wch(3X).

COLOPHON         top

       This page is part of the ncurses (new curses) project.  Information
       about the project can be found at 
       ⟨https://www.gnu.org/software/ncurses/ncurses.html⟩.  If you have a
       bug report for this manual page, send it to
       bug-ncurses-request@gnu.org.  This page was obtained from the
       project's upstream Git mirror of the CVS repository 
       ⟨git://ncurses.scripts.mit.edu/ncurses.git⟩ on 2017-09-15.  If you
       discover any rendering problems in this HTML version of the page, or
       you believe there is a better or more up-to-date source for the page,
       or you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a mail
       to man-pages@man7.org

                                                               curs_inch(3X)