1curs_inwstr(3X)                                                curs_inwstr(3X)
2
3
4

NAME

6       inwstr,  innwstr,  winwstr,  winnwstr,  mvinwstr, mvinnwstr, mvwinwstr,
7       mvwinnwstr - get a string of wchar_t characters from a curses window
8

SYNOPSIS

10       #include <curses.h>
11
12       int inwstr(wchar_t *wstr);
13       int innwstr(wchar_t *wstr, int n);
14       int winwstr(WINDOW *win, wchar_t *wstr);
15       int winnwstr(WINDOW *win, wchar_t *wstr, int n);
16
17       int mvinwstr(int y, int x, wchar_t *wstr);
18       int mvinnwstr(int y, int x, wchar_t *wstr, int n);
19       int mvwinwstr(WINDOW *win, int y, int x, wchar_t *wstr);
20       int mvwinnwstr(WINDOW *win, int y, int x, wchar_t *wstr, int n);
21

DESCRIPTION

23       These routines return a string of wchar_t wide characters in wstr,  ex‐
24       tracted starting at the current cursor position in the named window.
25
26       The  four  functions  with n as the last argument return a leading sub‐
27       string at most n characters  long  (exclusive  of  the  trailing  NUL).
28       Transfer  stops  at  the  end of the current line, or when n characters
29       have been stored at the location referenced by wstr.
30
31       If the size n is not large enough to store a complete  complex  charac‐
32       ter, an error is generated.
33

NOTES

35       All routines except winnwstr may be macros.
36
37       Each cell in the window holds a complex character (i.e., base- and com‐
38       bining-characters) together with attributes and color.  These functions
39       store  only  the  wide  characters, ignoring attributes and color.  Use
40       in_wchstr to return the complex characters from a window.
41

RETURN VALUE

43       All routines return ERR upon failure.  Upon successful completion,  the
44       *inwstr routines return OK, and the *innwstr routines return the number
45       of characters read into the string.
46
47       Functions with a “mv” prefix first  perform  a  cursor  movement  using
48       wmove, and return an error if the position is outside the window, or if
49       the window pointer is null.
50

SEE ALSO

52       curses(3X), curs_instr(3X), curs_in_wchstr(3X)
53
54
55
56                                                               curs_inwstr(3X)
Impressum