mvin_wch(3xcurses)

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

NAME

6       in_wch,  mvin_wch,  mvwin_wch,  win_wch  - retrieve a complex character
7       (with 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       int in_wch(cchar_t *wcval);
18
19
20       int mvin_wch(int y, int x, cchar_t *wcval);
21
22
23       int mvwin_wch(WINDOW *win, inty, cchar_t *wcval);
24
25
26       int win_wch(WINDOW *win, cchar_t *wcval);
27
28

DESCRIPTION

30       The in_wch() and win_wch() functions retrieve the complex character and
31       its  rendition  located  at  the current cursor position of the  stdscr
32       window and window win, respectively.  The  mvin_wch()  and  mvwin_wch()
33       functions  retrieve  the complex character and its rendition located at
34       the position indicated by the x  (column) and y (row)  parameters  (the
35       former in the stdscr window; the latter in window win).
36
37
38       All  these functions store the retrieved character and its rendition in
39       the  object pointed to by wcval.
40

PARAMETERS

42       wcval    Is a pointer to an object that can store a  complex  character
43                and its rendition.
44
45
46       y        Is  the y (row) coordinate of the position of the character to
47                be returned.
48
49
50       x        Is the x (column) coordinate of the position of the  character
51                to be returned.
52
53
54       win      Is  a  pointer to the window that contains the character to be
55                returned.
56
57

RETURN VALUES

59       On success, these functions return OK. Otherwise, they return ERR.
60

ERRORS

62       None.
63

ATTRIBUTES

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