inch(3xcurses)

1inch(3XCURSES)          X/Open Curses Library Functions         inch(3XCURSES)
2
3
4

NAME

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

SYNOPSIS

10       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
11        -R  /usr/xpg4/lib  -lcurses  [ library... ]
12
13       c89 [ flag... ] file... -lcurses [ library... ]
14
15       #include <curses.h>
16
17       chtype inch(void);
18
19
20       chtype mvinch(int y, int x);
21
22
23       chtype mvwinch(WINDOW *win, int y, int x);
24
25
26       chtype winch(WINDOW *win);
27
28

DESCRIPTION

30       The inch() and winch() functions return the chtype character located at
31       the  current  cursor  position  of  the  stdscr window  and window win,
32       respectively. The mvinch() and mvwinch() functions  return  the  chtype
33       character  located  at  the  position indicated by the x (column) and y
34       (row) parameters (the former in the stdscr window; the latter in window
35       win).
36
37
38       The  complete character/attribute pair will be returned.  The character
39       or attributes can be extracted by  performing  a  bitwise  AND  on  the
40       returned  value,  using  the  constants  A_CHARTEXT,  A_ATTRIBUTES, and
41       A_COLOR.
42

PARAMETERS

44       y      Is the y (row) coordinate of the position of the character to be
45              returned.
46
47
48       x      Is the x (column) coordinate of the position of the character to
49              be returned.
50
51
52       win    Is a pointer to the window that contains  the  character  to  be
53              returned.
54
55

RETURN VALUES

57       On  success,  these functions return the specified character and rendi‐
58       tion. Otherwise, they return ERR.
59

ERRORS

61       None.
62

ATTRIBUTES

64       See attributes(5) for descriptions of the following attributes:
65
66
67
68
69       ┌─────────────────────────────┬─────────────────────────────┐
70       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
71       ├─────────────────────────────┼─────────────────────────────┤
72       │Interface Stability          │Standard                     │
73       ├─────────────────────────────┼─────────────────────────────┤
74       │MT-Level                     │Unsafe                       │
75       └─────────────────────────────┴─────────────────────────────┘
76