win_wchnstr(3xcurses)

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

NAME

6       in_wchnstr,   in_wchstr,   mvin_wchnstr,   mvin_wchstr,  mvwin_wchnstr,
7       mvwin_wchstr, win_wchnstr,  win_wchstr  -  retrieve  complex  character
8       string (with rendition)
9

SYNOPSIS

11       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
12        -R  /usr/xpg4/lib  -lcurses  [ library... ]
13
14       c89 [ flag... ] file... -lcurses [ library... ]
15
16       #include <curses.h>
17
18       int in_wchnstr(cchar_t *wchstr, int n);
19
20
21       int in_wchstr(cchar_t *wchstr);
22
23
24       int mvin_wchnstr(int y, int x, cchar_t *wchstr, int n);
25
26
27       int mvin_wchstr(int y, int x, cchar_t *wchstr);
28
29
30       int mvwin_wchnstr(WINDOW *win, int y, int x, cchar_t *wchstr, int n);
31
32
33       int mvwin_wchstr(WINDOW *win, int y, int x, cchar_t *wchstr);
34
35
36       int win_wchnstr(WINDOW *win, cchar_t *wchstr, int n);
37
38
39       int win_wchstr(WINDOW *win, cchar_t *wchstr);
40
41

DESCRIPTION

43       The  in_wchstr() and win_wchstr() functions retrieve a complex  charac‐
44       ter string (with rendition) starting at the current cursor position  of
45       the  stdscr  window  and  window  win, respectively, and ending at  the
46       right margin. The mvin_wchstr() and mvwin_wchstr() functions retrieve a
47       complex  character  string  located  at the position indicated by the x
48       (column) and y (row) parameters (the former in the stdscr  window;  the
49       latter in window win).
50
51
52       The  in_wchnstr(),  win_wchnstr(), mvin_wchnstr(), and  mvwin_wchnstr()
53       functions retrieve at most n characters from  the   window  stdscr  and
54       win, respectively. The former two functions retrieve the string, start‐
55       ing at the current cursor  position; the latter two  commands  retrieve
56       the  string, starting at the position  specified by the x and y parame‐
57       ters.
58
59
60       The retrieved character string  (with  renditions)  is  stored  in  the
61       object pointed to by wcval.
62

PARAMETERS

64       wchstr    Is a pointer to an object where the retrieved complex charac‐
65                 ter string can be stored.
66
67
68       n         Is the number of characters not  to  exceed  when  retrieving
69                 wchstr.
70
71
72       y         Is  the  y  (row)  coordinate of the starting position of the
73                 string to be  retrieved.
74
75
76       x         Is the x (column) coordinate of the starting position of  the
77                 string to be  retrieved.
78
79
80       win       Is  a  pointer  to  the  window  in which the string is to be
81                 retrieved.
82
83

RETURN VALUES

85       On success, these functions return OK. Otherwise, they return ERR.
86

ERRORS

88       None.
89

ATTRIBUTES

91       See attributes(5) for descriptions of the following attributes:
92
93
94
95
96       ┌─────────────────────────────┬─────────────────────────────┐
97       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
98       ├─────────────────────────────┼─────────────────────────────┤
99       │Interface Stability          │Standard                     │
100       ├─────────────────────────────┼─────────────────────────────┤
101       │MT-Level                     │Unsafe                       │
102       └─────────────────────────────┴─────────────────────────────┘
103