1curs_inchstr(3CURSES)      Curses Library Functions      curs_inchstr(3CURSES)
2
3
4

NAME

6       curs_inchstr,   inchstr,   inchnstr,  winchstr,  winchnstr,  mvinchstr,
7       mvinchnstr, mvwinchstr, mvwinchnstr - get a string of  characters  (and
8       attributes) from a curses window
9

SYNOPSIS

11       cc [ flag ... ] file ... -lcurses [ library ... ]
12       #include <curses.h>
13
14       int inchstr(chtype *chstr);
15
16
17       int inchnstr(chtype *chstr, int n);
18
19
20       int winchstr(WINDOW *win, chtype *chstr);
21
22
23       int winchnstr(WINDOW *win, chtype *chstr, int n);
24
25
26       int mvinchstr(int y, int x, chtype *chstr);
27
28
29       int mvinchnstr(int y, int x, chtype *chstr, int n);
30
31
32       int mvwinchstr(WINDOW *win, int y, int x, chtype *chstr);
33
34
35       int mvwinchnstr(WINDOW *win, int y, int x, chtype *chstr, int n);
36
37

DESCRIPTION

39       With  these  routines, a string of type chtype, starting at the current
40       cursor position in the named window and ending at the right  margin  of
41       the  window,  is  returned. The four functions with n as the last argu‐
42       ment, return the string at most n characters long. Constants defined in
43       <curses.h> can be used with the & (logical AND) operator to extract the
44       character or the attribute alone from any position in  the  chstr  (see
45       curs_inch(3CURSES)).
46

RETURN VALUES

48       All  routines  return the integer ERR upon failure and an integer value
49       other than ERR upon successful completion.
50

ATTRIBUTES

52       See attributes(5) for descriptions of the following attributes:
53
54
55
56
57       ┌─────────────────────────────┬─────────────────────────────┐
58       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
59       ├─────────────────────────────┼─────────────────────────────┤
60       │MT-Level                     │Unsafe                       │
61       └─────────────────────────────┴─────────────────────────────┘
62

SEE ALSO

64       curs_inch(3CURSES), curses(3CURSES), attributes(5)
65

NOTES

67       The header <curses.h> automatically includes the headers  <stdio.h> and
68       <unctrl.h>.
69
70
71       Note that all routines except winchnstr() may be macros.
72
73
74
75SunOS 5.11                        31 Dec 1996            curs_inchstr(3CURSES)