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       int mvinwstr(int y, int x, wchar_t *wstr);
17       int mvinnwstr(int y, int x, wchar_t *wstr, int n);
18       int mvwinwstr(WINDOW *win, int y, int x, wchar_t *wstr);
19       int mvwinnwstr(WINDOW *win, int y, int x, wchar_t *wstr, int n);
20

DESCRIPTION

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

NOTES

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

RETURN VALUE

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

SEE ALSO

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