mvwinnwstr(3xcurses)

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

NAME

6       innwstr,  inwstr, mvinnwstr, mvinwstr, mvwinnwstr, mvwinwstr, winnwstr,
7       winwstr - retrieve a wide character string (without 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 innwstr(wchar_t *wstr, int n);
18
19
20       int inwstr(wchar_t *wstr);
21
22
23       int mvinnwstr(int y, int x, wchar_t *wstr, int n);
24
25
26       int mvinwstr(int y, int x, wchar_t *wstr);
27
28
29       int mvwinnwstr(WINDOW*win, int y, int x, wchar_t *wstr, int n);
30
31
32       int mvwinwstr(WINDOW*win, int y, int x, wchar_t *wstr);
33
34
35       int winwstr(WINDOW*win, wchar_t *wstr);
36
37
38       int winnwstr(WINDOW*win, wchar_t *wstr, int n);
39
40

PARAMETERS

42       wstr    Is a pointer to an object that can hold the retrieved multibyte
43               character string.
44
45
46       n       Is the number of characters not to exceed when retrieving wstr.
47
48
49       y       Is  the  y  (row)  coordinate  of  the starting position of the
50               string to be  retrieved.
51
52
53       x       Is the x (column) coordinate of the starting  position  of  the
54               string to  be retrieved.
55
56
57       win     Is  a  pointer  to  the  window  in  which  the string is to be
58               retrieved.
59
60

DESCRIPTION

62       The inwstr() and winwstr() functions retrieve a wide  character  string
63       (without  attributes)  starting  at the current cursor position  of the
64       stdscr window and window win, respectively, and  ending  at  the  right
65       margin.  The mvinwstr() and mvwinwstr() functions retrieve a wide char‐
66       acter string located at the position indicated by the x (column) and  y
67       (row)  parameters (the former in the stdscr window; the latter  in win‐
68       dow win).
69
70
71       The innwstr(), winnwstr(),  mvinnwstr(),  and   mvwinnwstr()  functions
72       retrieve  at most n characters from the  window stdscr and win, respec‐
73       tively.  The former two functions retrieve the string starting  at  the
74       current  cursor  position;  the  latter two commands return the string,
75       starting at the position  specified by the x and y parameters.
76
77
78       All these functions store the retrieved string in the object pointed to
79       by  wstr. They only store complete wide characters. If the area pointed
80       to by wstr is not large enough to hold at least  one  character,  these
81       functions fail.
82
83
84       Only the character portion of the character/rendition pair is returned.
85       To  return  the  complete  character/rendition   pair,   use   win_wch‐
86       str(3XCURSES).
87

RETURN VALUES

89       On  success, the inwstr(), mvinwstr(), mvwinwstr(), and winwstr() func‐
90       tions return OK. Otherwise, they return ERR.
91
92
93       On success, the innwstr(), mvinnwstr(),  mvwinnwstr(),  and  winnwstr()
94       functions  return the number of characters read into the string. Other‐
95       wise, they return ERR.
96

ERRORS

98       None.
99

ATTRIBUTES

101       See attributes(5) for descriptions of the following attributes:
102
103
104
105
106       ┌─────────────────────────────┬─────────────────────────────┐
107       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
108       ├─────────────────────────────┼─────────────────────────────┤
109       │Interface Stability          │Standard                     │
110       ├─────────────────────────────┼─────────────────────────────┤
111       │MT-Level                     │Unsafe                       │
112       └─────────────────────────────┴─────────────────────────────┘
113