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 *str);
13       int innwstr(wchar_t *str, int n);
14       int winwstr(WINDOW *win, wchar_t *str);
15       int winnwstr(WINDOW *win, wchar_t *str, int n);
16       int mvinwstr(int y, int x, wchar_t *str);
17       int mvinnwstr(int y, int x, wchar_t *str, int n);
18       int mvwinwstr(WINDOW *win, int y, int x, wchar_t *str);
19       int mvwinnwstr(WINDOW *win, int y, int x, wchar_t *str, int n);
20

DESCRIPTION

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

NOTES

34       Note that all routines except winnwstr may be macros.
35

RETURN VALUE

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

SEE ALSO

46       curses(3X), curs_instr(3X), curs_in_wchstr(3X)
47
48
49
50                                                               curs_inwstr(3X)
Impressum